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 |
|---|---|---|---|
| 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 | Yes | ||
| username | No | Contacts with a profile of this username, without its display prefix. One username may match several contacts. Give this or the other identity filter, repeating the key for up to 100. No match is an empty page. | |
| platformId | No | Contacts with a profile of this platform ID. Give this or the other identity filter, repeating the key for up to 100. No match is an empty page. |