Contacts

List contacts

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}.

get/v1/contacts

Request

  • Base URL: https://api.samva.dev
  • URL: https://api.samva.dev/v1/contacts
  • Auth: API key in header x-api-key

Query parameters

limitstring nullable
cursorstring
namespaceIdstring
searchstring nullable
status'active' | 'paused' | 'blocked' | 'archived' nullable
fieldsstring nullable
customFieldstring nullable
customFieldValuestring nullable
afterstring nullable
beforestring nullable

Response

ContactPage

nextCursorstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.