Skip to main content

List Customer Contacts

GET 

/api/v2/customers/:customer/contacts

List all contacts attached to a customer, paginated. Supports search (title/notes), role/primary/has-email filters, advanced per-column filters, and sorting.

Required scope: customers:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token.

portal_user reports the customer-portal login granted to this contact, or null when they have none — portal access is a property of the contact, so there is one list of people per customer. The field is absent for supplier and warehouse contacts, which have no portal.

Request​

Responses​

OK

Response Headers
    Content-Type