Sign in

v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB
Customers

Lists all customers

Returns customers for accounts receivable with pagination and optional search or external-reference filters.

get/customers

Query parameters

limitinteger

Maximum number of rows to return in the page.

cursorstring

If defined, a cursor to retrieve the next page.

Example:iLQvkEj3sh3UiweC

Pagination cursor to navigate through the full response.

searchstring

Filter customer by name.

external_reference_idstring

If this is provided, external_reference_type must also be provided.

external_reference_typestring

If this is provided, external_reference_id must also be provided.

updated.gtstring date-time
Example:2023-01-01T00:00:00Z

Filter customers updated after this timestamp

sort_by'created' | 'updated'

the field the customers should be sorted by descending (either created or updated)

Response

OK

Example response

{
  "customers": [
    {
      "name": "Bob",
      "name_on_invoice": "Bob Johnson",
      "address": {
        "line1": "123 Main St",
        "line2": "Apt 4B",
        "city": "Nashville",
        "state": "TN",
        "zip_code": "37201",
        "country": "US"
      },
      "shipping_address": {
        "line1": "123 Main St",
        "line2": "Apt 4B",
        "city": "Nashville",
        "state": "TN",
        "zip_code": "37201",
        "country": "US"
      },
      "emails": [
        {
          "email": "bobjohnson@somedomain.com"
        }
      ],
      "external_references": [
        {
          "type": "xyzSystemId",
          "id": "234",
          "url": "https://xyzsystempage.com/ids/234"
        }
      ]
    }
  ],
  "pagination": {
    "next_cursor": "iLQvkEj3sh3UiweC"
  }
}