Skip to main content
GET
List worker addresses

Parameters

worker
string
Filter by worker ID.
purpose
string
Filter by purpose. One of residential, business, or shipping.
current
boolean
Filter by whether the address is current.
limit
integer
Maximum number of addresses to return.
cursor
string
Pagination cursor from a previous response.
starting_after
string
Return addresses after this worker address ID.
ending_before
string
Return addresses before this worker address ID.

Returns

Returns a list object containing Worker address objects.