List Contacts

Required scope: contact:read

Lists contacts in the workspace. search matches on name, email, and phone; omit it to list all contacts. Results are page-based: page is zero-indexed and pageSize defaults to 100 (maximum 100). The response echoes the applied page and pageSize and returns total, the unpaged match count.

Generated Reference

POST /public-api/publicapi.v1.Contact/ListContacts

Lists contacts in the workspace, with optional free-text search over name, email, and phone number, and page-based pagination.

Request ListContactsRequest

Response ListContactsResponse

ListContactsRequest

Field	Type	Description
search	string	Optional free-text search over contact name, email, and phone number.
page	int32	1-based page number. Defaults to 1.
page_size	int32	Page size, 1-100. Defaults to 50.

ListContactsResponse

Field	Type	Description
contacts	repeated Contact	Contacts on the requested page.
total	int32	Total contacts matching the search across all pages.
page	int32	Echoed 1-based page number.
page_size	int32	Echoed page size.

Related Types

Contact

Field	Type	Description
id	string	Stable contact identifier.
name	string	Display name, if set.
email	string	Email address, if set.
phone_e164	string	Phone number in E.164 format, if set.
customer_number	string	Human-facing customer number when the contact is linked to a customer.
locale	string	BCP 47 locale tag, for example "en" or "nl-NL", if set.
created_at	int64	Creation time as a Unix timestamp in seconds.
updated_at	int64	Last-update time as a Unix timestamp in seconds.

Request

{
  "search": "alex",
  "page": 0,
  "pageSize": 50
}

Response

{
  "contacts": [
    {
      "id": "<contact-id>",
      "name": "Alex Jansen",
      "email": "[email protected]",
      "phoneE164": "+31612345678",
      "customerNumber": "C-000123",
      "locale": "nl-NL",
      "createdAt": 1726300000,
      "updatedAt": 1726400000
    }
  ],
  "total": 1,
  "page": 0,
  "pageSize": 50
}