Offices

Your agency's offices (branches). Patients, caregivers and applicants can each belong to one office. There is always exactly one default office.

Endpoints

The Office object

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.