AveeCare

Retrieve an office

get/v1/offices/{id}

Returns one office by ID. 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

Path parameters

id
stringrequired

ID of the office.

Response

200

The office.

object
stringread-only

String representing the object's type. Always office.

id
stringread-only

Unique identifier of the office.

name
string | nullmax length 200

Office name.

address
string | nullmax length 200

Street address.

city
string | nullmax length 100

City.

state
string | nullmax length 50

State, as a two-letter code.

zipCode
string | nullmax length 20

ZIP code.

phone
string | nullmax length 30

Main phone number.

isDefault
boolean | null

Whether this is the default office. Making another office the default clears this one.

createdAt
string · date-time | nullread-only

When the office was created.

updatedAt
string · date-time | nullread-only

When the office 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.