Skip to content

List company addresses

GET
/addresses
curl --request GET \
--url 'https://api.fleet.co/platform/v1/addresses?limit=50&offset=0' \
--header 'Authorization: Bearer <token>'
limit

Page size (max 100)

integer
default: 50 >= 1 <= 100

Example

50
offset

Number of items to skip

integer
0

Example

0

Paginated addresses

Media typeapplication/json
object
data
required
Array<object>
object
id
required
integer
first_name
required
string
nullable
last_name
required
string
nullable
phone
required
string
nullable
phone_country
required
string
nullable
email
required
string
nullable
address1
required
string
nullable
address2
required
string
nullable
type
required

Address kind: OFFICE, HOME, PO_BOX or EXTERNAL_STORAGE

string
nullable
zip
required
string
nullable
city
required
string
nullable
state
required

Legacy free-text state, no longer written: read administrative_area instead.

string
nullable
administrative_area
required

Local subdivision code

string
nullable
administrative_area_iso
required

ISO 3166-2 subdivision code

string
nullable
country
required

ISO 3166-1 alpha-2 country code

string
nullable
label
required
string
nullable
comment
required
string
nullable
is_default
required
boolean
is_hq
required
boolean
user_id
required

Employee who lives at this HOME address; null for other addresses

integer
nullable
created_at
required
string
nullable
updated_at
required
string
nullable
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
Allowed values: validation_error
error
required
string
Allowed values: validation_error

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

Unauthorized

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
Allowed values: INTERNAL_ERROR

Example

{
"error": "INTERNAL_ERROR"
}

Rate limiting is temporarily unavailable; retry with backoff

Media typeapplication/json
object
message
required
string

Example generated

{
"message": "example"
}