Get one company address by id
GET
/addresses/{address_id}
const url = 'https://api.fleet.co/platform/v1/addresses/42';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.fleet.co/platform/v1/addresses/42 \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”address_id
required
Address id
string
Example
42Responses
Section titled “Responses”Address
Media typeapplication/json
object
data
required
object
id
required
integer
first_name
required
string
last_name
required
string
phone
required
string
phone_country
required
string
email
required
string
address1
required
string
address2
required
string
type
required
Address kind: OFFICE, HOME, PO_BOX or EXTERNAL_STORAGE
string
zip
required
string
city
required
string
state
required
Legacy free-text state, no longer written: read administrative_area instead.
string
administrative_area
required
Local subdivision code
string
administrative_area_iso
required
ISO 3166-2 subdivision code
string
country
required
ISO 3166-1 alpha-2 country code
string
label
required
string
comment
required
string
is_default
required
boolean
is_hq
required
boolean
user_id
required
Employee who lives at this HOME address; null for other addresses
integer
created_at
required
string
updated_at
required
string
Example
{ "data": { "administrative_area": "MI", "administrative_area_iso": "IT-MI", "country": "FR" }}Validation error
Media typeapplication/json
object
message
required
Every validation failure, comma-separated
string
type
required
string
error
required
string
Example
{ "message": "Required, must be an ISO 3166-1 alpha-2 country code", "type": "validation_error", "error": "validation_error"}Missing, invalid, or revoked API key
Media typetext/plain
string
Example
UnauthorizedAddress not found
Media typeapplication/json
object
error
required
string
Example
{ "error": "ADDRESS_NOT_FOUND"}Rate limit exceeded. The RateLimit-* headers give the limit and the reset time.
Media typetext/plain
string
Example
Too many requests, please try again later.Unexpected server error
Media typeapplication/json
object
error
required
string
Example
{ "error": "INTERNAL_ERROR"}Rate limiting is temporarily unavailable; retry with backoff
Media typeapplication/json
object
message
required
string
Example generated
{ "message": "example"}
