Skip to main content
GET
/
addresses
List Addresses
curl --request GET \
  --url https://api.synctera.com/v2/addresses
{
  "addresses": [
    {
      "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",
      "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"
    }
  ],
  "next_page_token": "a8937a0d"
}

Query Parameters

​
customer_id
string<uuid>

The unique identifier for customer

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
business_id
string<uuid>

The unique identifier for business

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
address_type
enum<string>[]

Specifies the address type.

​
is_registered_agent
boolean

Whether the address uses a registered agent or not

​
is_active
boolean

Whether the address is active or not

​
country
string

Country code.

Example:

"U"

​
limit
integer
default:100

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

Required range: x >= 1
Example:

100

​
page_token
string

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

Example:

"a8937a0d"

Response

List of addresses

​
addresses
object[]
required

Array of Addresses

​
next_page_token
string

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

Example:

"a8937a0d"