List contacts
Returns contact summaries for the organization, newest first, filterable by search term, status, and creation time (`after`, `before`).
Returns contact summaries for the organization, newest first, filterable by search term, status, and creation time (after, before). fields is a comma-separated list of defined custom field keys to return in each summary's customFields; omitted keys and unselected fields are not returned. Filter by one defined custom field with customField and a JSON-encoded scalar customFieldValue (for example, "creator", 42, or true). Both filter parameters are required together, and unknown keys or values of the wrong type are rejected. Pass nextCursor back as cursor for the next page; it is null on the last page. Read full identities, profile, and metadata with GET /v1/contacts/{id}.
Authorization
apiKey In: header
Query Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/contacts"{ "items": [ { "id": "string", "name": "string", "displayName": "string", "status": "active", "email": "string", "channels": [ "email" ], "tags": [ "string" ], "lists": [ { "id": "string", "name": "string", "color": "clay" } ], "customFields": { "property1": "string", "property2": "string" }, "lastActiveAt": "string", "createdAt": "string" } ], "nextCursor": "string"}Related documentation
List a contact's group memberships
Returns the contact groups a contact belongs to, most recently joined first. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page.
Delete a contact
Permanently deletes a contact by its ID. Use this endpoint to delete a contact through the Samva email API.