List authorizations

get/v1/authorizations

Returns a page of authorizations. Filters combine with AND. Use next_cursor to fetch the next page. Available to keys belonging to office staff.

Authorization

Authorization: Bearer ak_...requiredscope: read

An AveeCare API key created in Settings → API Keys. A read or read + write key can call this endpoint. About authentication

Query parameters

limit

integerdefault: 25min 1max 100

Number of objects to return, from 1 to 100.

cursor

string

The next_cursor from the previous page. Send the same filters with it.

patient_id

string

Only return authorizations for this patient.

status

string

Only return authorizations with this status.

One ofActiveExpiredPendingRenewal

created_after

string · date-time

Only return objects created after this time (exclusive). ISO 8601 with a time zone.

created_before

string · date-time

Only return objects created before this time (exclusive). ISO 8601 with a time zone.

updated_after

string · date-time

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.

updated_before

string · date-time

Only return objects last changed before this time (exclusive). ISO 8601 with a time zone.

Response

200

A page of results.

object

string

Always list.

data

array of objects

The authorizations on this page.

Show item attributesHide item attributes(22)

object

stringrequiredread-only

String representing the object's type. Always authorization.

stringrequiredread-only

Unique identifier of the authorization.

patientId

string | nullrequiredmax length 64

The patient the authorization covers.

payerName

string | nullrequiredmax length 200

The payer that issued it.

authorizationNumber

string | nullrequiredmax length 100

The payer's authorization number.

serviceType

string | nullrequiredmax length 100

Service authorized.

procedureCode

string | nullrequiredmax length 20

Procedure (HCPCS) code billed against it.

modifiers

string | nullrequiredmax length 50

Procedure code modifiers, comma separated.

startDate

string · date | nullrequired

First date the authorization covers.

endDate

string · date | nullrequired

Last date the authorization covers.

authorizedUnits

integer | nullrequiredmin 0

Units approved.

unitType

string | nullrequiredmax length 50

What a unit is, in the payer's words.

unitBasis

string | nullrequired

Whether units count time, visits or days.

One ofTimeVisitsDaysnull

minutesPerUnit

integer | nullrequiredmin 1

For time-based units, minutes in one unit.

usedUnits

integer | nullrequiredread-only

Units used so far.

remainingUnits

integer | nullrequiredread-only

Units left.

frequency

string | nullrequiredmax length 100

Frequency the payer approved.

placeOfService

string | nullrequiredmax length 10

Place-of-service code.

status

string | nullrequired

Whether the authorization is in effect.

One ofActiveExpiredPendingRenewalnull

notes

string | nullrequiredmax length 20000

Notes.

createdAt

string · date-time | nullrequiredread-only

When the authorization was created.

updatedAt

string · date-time | nullrequiredread-only

When the authorization was last changed.

next_cursor

string | null

Pass as cursor to fetch the next page. null on the last page.

has_more

boolean

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.