View guarantor balances

get

https://nexhealth.info/guarantor_balances

This endpoint returns a list of guarantor balances. You can filter by guarantor or updated_since. You must provide at least one filter.

Query Params

subdomain

string

required

Used to scope the request to the specified institution

location_id

int32

required

Used to scope the request to the specified location

sort

string

Defaults to null

Optional comma-separated string of fields to sort on. Include a leading dash for descending order.

Available fields:

updated_at
-updated_at

guarantor_id

int32

Filter by guarantor

updated_since

date-time

Guarantor guarantor balances updated after the specified time (UTC)

show_zero_balances

boolean

Defaults to false

Show guarantor balances with zero total balance

start_cursor

string

First item of the current page. Starts empty

end_cursor

string

Last item of the current page. Starts empty

per_page

int32

Defaults to 5

Number of results to return per page. Maximum allowed amount is 1000.

Headers

Nex-Api-Version

string

required

Defaults to v20240412

The NexHealth API version

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful

400Bad Request

401Unauthorized

403Forbidden

500Internal Server Error