v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

Addresses

List Addresses

get/addresses

Query parameters

countrystring

ISO 3166-1 Alpha-2 or Alpha-3 country code.

Example:U

Country code.

business_idstring uuid

Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

The unique identifier for business

is_registered_agentboolean

Whether the address uses a registered agent or not

customer_idstring uuid

Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

The unique identifier for customer

page_tokenstring

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:a8937a0d

is_activeboolean

Whether the address is active or not

limitinteger

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Example:100

address_typestring[]

Specifies the address type.

Response

List of addresses

next_page_tokenstring

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example response

{
  "addresses": [
    {
      "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "creation_date": "2019-01-01T00:00:00Z",
      "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "is_active": true,
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "address_line_1": "100 Main St.",
      "address_line_2": "Suite 99",
      "address_type": "SHIPPING",
      "city": "New York",
      "country_code": "US",
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "is_registered_agent": true,
      "nickname": "Home",
      "postal_code": "28620",
      "state": "NY"
    }
  ],
  "next_page_token": "a8937a0d"
}