Browse the docs

List a customer's contacts

GET/api/v1/customers/{customer_id}/contacts

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 listCustomerContacts.

Parameters

In the address

customer_idstring (uuid)required

In the query string

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

Responses

200Paginated contacts.

dataarray of objectrequired
Each item(12)
- lock_versioninteger
  At least 0.
- created_atstring (date-time)required
- updated_atstring (date-time)required
- idstring (uuid)required
- account_idstring (uuid)required
- customer_idstring (uuid)required
- namestringrequired
- job_titlestring or null
- emailstring (email) or null
- phonestring or null
- notesstring or null
- archived_atstring (date-time) or null
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/372a8e62-6d44-552f-9c0e-c1229b6478be/contacts?page=1&per_page=50" \
  -H "Authorization: Bearer $TRADESENDER_KEY"