Skip to main content
GET
Fetch an address

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

address_id
integer
required

The ID of the address.

Response

200 - application/json

OK

address_one
string
required

The first line of the address.

Maximum string length: 100
city
string
required

The city of the address.

Maximum string length: 100
client_id
integer
required

The ID of the client that this address belongs to.

clinic_id
integer | null
required

The ID of the clinic this address belongs to.

created
string<date-time>
required

The datetime this object was created.

deleted
string<date-time> | null
required

The datetime this record was soft deleted.

id
integer
required

The ID of the address.

is_deleted
boolean
required

Whether this record is soft deleted or not.

is_primary
boolean
required

Whether this address is the primary address of the client.

modified
string<date-time>
required

The datetime this object was last modified; changes to related entities will not update this field.

state
string
required

The 2-letter code of the state/province/region of the address. Legacy data could deviate from the 2-letter code convention.

zipcode
string
required

The zip code/postal code of the address.

Maximum string length: 10
address_two
string
default:""

The second line of the address.

Maximum string length: 100
country
enum<string>
default:US

The 2-letter code of the country of the address.

Available options:
CA,
US,
AS,
GU,
MP,
PR,
VI
county
string
default:""

The county of the address.

Maximum string length: 100
name
string
default:""

The name of the address.

Maximum string length: 100
phone_number
integer | null

The phone number of the address.