AveeCare

Retrieve a certification

get/v1/certifications/{id}

Returns one certification by ID. Available to keys belonging to office staff and caregivers.

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

Path parameters

id
stringrequired

ID of the certification.

Response

200

The certification.

object
stringread-only

String representing the object's type. Always certification.

id
stringread-only

Unique identifier of the certification.

caregiverId
string | nullmax length 64

The caregiver who holds it.

name
string | nullmax length 200

Name of the certification.

certKind
string | nullmax length 50

Kind of credential, such as a certification or a background check.

obtained
string · date | null

Date it was obtained.

expires
string · date | null

Date it expires.

checkAgency
string | nullmax length 200

For background checks, the agency that ran the check.

checkState
string | nullmax length 50

For background checks, the state the check covers.

checkResult
string | nullmax length 100

For background checks, the result.

verifiedByName
string | nullread-onlymax length 2000

Who verified the credential.

verifiedAt
string · date-time | nullread-only

When the credential was verified.

createdAt
string · date-time | nullread-only

When the certification was created.

updatedAt
string · date-time | nullread-only

When the certification was last changed.

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).
403
n/a
The key is read-only (insufficient_scope), or its user's role cannot do this (forbidden).
404
n/a
No such object, or it is not visible to this key (not_found).
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.