AveeCare

Retrieve the current API key

get/v1/me

Returns the API key making the request, its scopes, the role of the user it belongs to, and its agency. Useful to check a key works.

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

Response

200

The API key.

object
stringread-only

Always me.

id
stringread-only

The key's public identifier: the part of the key between ak_ and the second underscore.

name
string | nullread-only

The name given to the key when it was created.

scopes
array of stringsread-only

What the key may do. A key without write can only read.

One ofreadwrite
role
stringread-only

Role of the person the key belongs to: RootUser (agency administrator), User (office staff), Caregiver or Patient. It decides which resources the key can reach.

One ofRootUserUserCaregiverPatient
email
string · emailread-only

Email address of the person the key belongs to.

expiresAt
string · date-timeread-only

When the key stops working.

organization
objectread-only

The agency the key belongs to.

Show child attributesHide child attributes(2)
id
stringrequired

ID of the agency.

name
string | nullrequired

Agency name.

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

StatusCodeMeaning
401
n/a
The API key is missing, malformed, expired or revoked (unauthorized).
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.