Skip to main content
Browse the docs

List customers

GET/api/v1/customers

  • Needs an API key, and runs with the access of the member who made the key.
  • A connected AI assistant can use it too, as listCustomers.

Parameters

In the query string

  • pageinteger

    Default: 1. At least 1.

  • per_pageinteger

    Default: 50. At least 1. At most 100.

  • querystring

  • include_archivedboolean

    Default: false.

  • include_detailsboolean

    Embed each customer's current contacts and properties, as on the customer page.

    Default: false.

Responses

200Paginated customers.

  • dataarray of one of several shapesrequired

    Customers, or CustomerDetail items when include_details is true.

  • metaobjectrequired

    Fields(4)

    • pageintegerrequired

      At least 1.

    • per_pageintegerrequired

      At least 1. At most 100.

    • totalintegerrequired

      At least 0.

    • total_pagesintegerrequired

      At least 0.

A refusal answers in the one error shape every operation shares.

Example

A request our own tests send. The ids are made up: put your own in their place.

curl "https://app.tradesender.co.uk/api/v1/customers?page=1&per_page=50&query=Taylor&include_archived=false" \
  -H "Authorization: Bearer $TRADESENDER_KEY"