SEsentdm
Contacts

Get contacts list

Changed on

Retrieves a paginated list of contacts for the authenticated customer. Supports filtering by search term, channel, or phone number.

get/v3/contacts

Request

  • Base URL
    https://api.sent.dm
  • URL
    https://api.sent.dm/v3/contacts
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Query parameters

pageinteger required

Page number (1-indexed)

page_sizeinteger required

Number of items per page

searchstring nullable

Optional search term for filtering contacts

channelstring nullable

Optional channel filter (sms, whatsapp)

phonestring nullable

Optional phone number filter (alternative to list view)

Headers

x-profile-idstring uuid

Profile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.

Response

Contacts retrieved successfully

successboolean

Indicates whether the request was successful

Changes

  • 6c829543a93eRevision changes
    • breaking

      added to the response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • info

      the endpoint scheme security BearerAuth was added to the API

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property oneOf list for the response status

    • info

      removed from the response property oneOf list for the response status

    • info

      removed from the response property oneOf list for the response status

    • info

      removed from the response property oneOf list for the response status