Skip to main content

Retrieve an address from a location

Retrieves a Location Address resource.

Authorizations:Token, JWT
Query Parameters
location_id
required
integer>= 1

Responses

200Location Address resource
Response schema:
Location Address resource
addressstring[1 .. 765] charactersThe street address.Example: "123 Main Street, Suite 4B"
citystring[1 .. 255] charactersThe city name.Example: "New York"
zipcodestring[1 .. 255] charactersThe postal or ZIP code.Example: "10001"
state_namestring[0 .. 255] charactersThe full name of the state or province. Use this for countries without a standardized state code list.Example: "New York"
state_codestring[0 .. 64] charactersThe standardized code for the state or province (e.g., ISO 3166-2).Example: "NY"
country_codestring[2 .. 3] charactersThe two-letter ISO 3166-1 alpha-2 country code.Example: "US"
idinteger or null>= 1
401Unauthorized
Response schema:
Unauthorized
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null
404Resource not found
Response schema:
Resource not found
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null
500Internal error
Response schema:
Internal error
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null