API explorer
Fleet Management API Beta

Sections

Theme switcher

Get an address.

Authentication

Bearer Token

Standard HTTP Bearer token. Enter the 'access_token' value.

TokenstringRequired

Header Parameters

Authorizationstring

This API is protected under OAuth 2 with the client_credentials grant flow and requires an API client_id and client_secret.
The client_id and client_secret are provisioned by the Fleet Services team.

Access Tokens have a lifespan of 15 minutes.

Requesting an access token

Parameters:

  • client_id = my-client-id
  • client_secret = my-client-secret
  • [base-url] = Replace with the correct server URL for the environment you are using (e.g. - https://wmd.xc.wexonl...

Path Parameters

address-idstring Required

The row ID for the Address record

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

citystring

City.

contact_idstring

The contact to which this address is associated.

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.

care_ofstring

Optional third line of the address.

contact_namestring

Person to contact.

contact_phone_numberstring

Phone number of the person to contact.

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?