List patients
/v1/patientsReturns a page of patients. Filters combine with AND. Use next_cursor to fetch the next page. Available to keys belonging to office staff and caregivers.
Query parameters
Number of objects to return, from 1 to 100.
The next_cursor from the previous page. Send the same filters with it.
Only return patients with this status.
Only return active (true) or inactive (false) patients.
Only return prospects or clients.
ProspectClientOnly return patients served by this office.
Only return objects created after this time (exclusive). ISO 8601 with a time zone.
Only return objects created before this time (exclusive). ISO 8601 with a time zone.
Only return objects last changed after this time (exclusive). ISO 8601 with a time zone. Use it for incremental sync: pass the newest updatedAt you already have.
Only return objects last changed before this time (exclusive). ISO 8601 with a time zone.
Response
200A page of results.
Always list.
The patients on this page.
Show item attributesHide item attributes(38)
String representing the object's type. Always patient.
Unique identifier of the patient.
Given name.
Middle name.
Family name.
The name the patient prefers to be called.
Date of birth.
Gender as recorded by the agency.
Language the patient is most comfortable speaking.
Contact email address.
Whether the patient is an active client. Only active clients are scheduled and billed. A prospective client is always inactive. If you leave it out on create, it is false for a prospect or an Inactive or Discharged status and true otherwise.
The client's status as shown in AveeCare. Inactive and Discharged mean the person is no longer receiving care. A prospective client (lifecycleStage: Prospect) reads Prospect even if you send Active. Creating a patient with Prospect makes them a prospective client. Defaults to Active. Usually one of Active, Inactive, Prospect, Discharged; records imported from another system can hold other values.
Whether this person is a prospective client or an admitted client. null means client. Prospects appear in the prospective-patient pool in AveeCare, not on the patient roster.
ProspectClientnullThe main type of service the patient receives.
SkilledNursingPhysicalTherapyHospiceStandardCarenullStreet address where care is delivered.
City of the service address.
State of the service address, as a two-letter code.
ZIP code of the service address.
The office (branch) that serves this patient.
The referral source that sent this patient to you.
Primary diagnosis, in plain words.
Whether the patient is a fall risk.
Caregiver gender the patient prefers, if any.
Notes schedulers see when booking visits for this patient.
Person legally responsible for the patient, if not the patient.
Medicaid member ID.
Medicare beneficiary identifier.
Primary insurance company name.
Member ID with the primary insurance.
Group number with the primary insurance.
Who receives the bills.
Email address bills are sent to.
Phone number of the billing contact.
How statements are delivered.
EmailMailEmailAndMailNoStatementnullHow the patient usually pays.
ACHCardCheckCashPayerOnlyOthernullBalance the patient currently owes. In cents.
When the patient was created.
When the patient was last changed.
Pass as cursor to fetch the next page. null on the last page.
Whether another page exists.
Response headers
Request-IdstringUnique ID of this request. Quote it when contacting support.RateLimit-LimitintegerRequests allowed in the current window.RateLimit-RemainingintegerRequests left in the current window.RateLimit-ResetintegerSeconds until the window resets.Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | n/a | The request was malformed, a value was invalid, or it contained an unknown field (invalid_request, unknown_field). |
| 401 | n/a | The API key is missing, malformed, expired or revoked (unauthorized). |
| 403 | n/a | The key is read-only (insufficient_scope), or its user's role cannot do this (forbidden). |
| 429 | n/a | Too many requests (rate_limited). Wait for Retry-After seconds. |
| 500 | n/a | Something went wrong on our side (internal_error). Retry, and quote the request ID if it persists. |
Every error uses the same body. See Errors for the full list of codes.