Find contacts
contacts_listFind contacts
Finds contacts by the platform identity of one of their profiles: a platform with platformId or username.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Searches contact and profile names, usernames, emails and phone numbers. Not combinable with `platformId` or `username`. Results follow `createdAt`, not relevance, and can trail changes by a few seconds. | |
| limit | No | Page size, from 1 to 100. Defaults to 50. | |
| cursor | No | The previous page's `nextCursor`. Opaque, and valid only with the filters it was issued for. | |
| expand | No | Related resources to embed next to their ID field, one path per key, at most 4. | |
| platform | No | Contacts with a profile on these platforms. Defaults to every platform available to the team. `platformId` needs exactly one. Repeat the key to match any of several. | |
| username | No | Contacts with a profile of this username, without its display prefix. One username may match several contacts. Give one of `platformId`, `username` or `q`, repeating the key for up to 100. No match is an empty page. | |
| platformId | No | Contacts with a profile of this platform ID. Give one of `platformId`, `username` or `q`, repeating the key for up to 100. No match is an empty page. |