List company addresses
GET
/addresses
const url = 'https://api.fleet.co/platform/v1/addresses?limit=50&offset=0';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?limit=50&offset=0' \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”limit
Page size (max 100)
integer
Example
50offset
Number of items to skip
integer
Example
0Responses
Section titled “Responses”Paginated addresses
Media typeapplication/json
object
data
required
Array<object>
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
meta
required
object
total
required
Total items matching filters (before paging)
integer
limit
required
Page size used for this response
integer
offset
required
Offset used for this response
integer
Example
{ "data": [ { "administrative_area": "MI", "administrative_area_iso": "IT-MI", "country": "FR" } ], "meta": { "total": 42, "limit": 50, "offset": 0 }}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
UnauthorizedRate 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"}
