Skip to content

List employee personal address links

GET
/user-addresses
curl --request GET \
--url 'https://api.fleet.co/platform/v1/user-addresses?limit=50&offset=0&user_id=42' \
--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
user_id

Only the personal address link of this employee

integer

Example

42

Paginated user-address links

Media typeapplication/json
object
data
required
Array<object>
object
user_id
required
integer
address_id
required
integer
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

{
"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"
}