Fleet Management API Beta

Sections

Theme switcher

Get an address

Header Parameters

Authorizationstring

Path Parameters

address-idstring Required

Address Id.

Min length
1

Response

200
Object

The address that was requested

Response Attributes

account_idstring

Identifier of the account to which the address is associated.

address_idstring

Unique address identifier.

address_line1string

First line of the address.

address_line2string

Second line of the address.

address_typesarray

The type of address.

Show child attributes

care_ofstring

Optional third line of the address.

citystring

City.

contact_idstring

The contact to which this address is associated.

contact_namestring

Person to contact.

contact_phone_numberstring

Phone number of the person to contact.

country_codestring

Two letter country abbreviations.

Enum values:
CAMXPRUSUNKNOWN
municipalitystring

A local administrative government subdivision. Primarily used for Mexico

postal_codestring

Address zipcode including PO Box extension.

requested_bystring

The name of the user requesting the change.

residential_indicatorboolean

Indicates if this is a residential address.

statestring

The two letter state code the address is located in.

statusstring

Address status.

400
Object

400 (Bad Request)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
401
Object

401 (Unauthorized)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
403
Object

403 (Forbidden)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
404
Object

404 (Not Found)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
500
Object

500 (Internal Server Error)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?