REreteno
Contacts

Search for contacts

Changed on

<br>Search for contacts. The method returns max 500 results.<br> The total amount of contacts is in the <b>TotalCount</b> header.

get/api/v1/contacts

Request

Query parameters

externalCustomerIdstring

External contact ID

emailstring

Contact's email address

smsstring

Contact's phone number

firstnamestring

Contact first name

lastnamestring

Contact last name

startindexinteger

The number of the first contact returned in the search results.<br/>Numbering starts at 1

maxrowsinteger

Maximum number of returned contacts (max 500)

sortBystring

Possible value is 'contactId'. Only actual for searches without conditions. By default, the date of contact update is used for the search.<br>If this parameter is used, sorting is done by contactId. Using this parameter allows you to upload contacts faster.

Response

firstNamestring
lastNamestring
addressBookIdinteger

Catalog ID.<br/>You can get the value using the <i> GET /v1/addressbooks</i> method.<br/>Optional parameter.

idinteger

Example response

[
  {
    "channels": [
      {
        "device": {
          "appId": "83b77a49-fc28-409b-aeaa-68c9d544ab9d",
          "deviceModel": "iPhone 16 Pro",
          "os": "iOS",
          "locale": "en_UK",
          "clientVersion": "1.6.8",
          "appVersion": "1.23.45"
        }
      }
    ],
    "fields": [
      {
        "id": 79814,
        "value": "textfield"
      }
    ]
  }
]

Changes

  • 7e3e7243824fRevision changes
    • warning

      added the new inapp enum value to the /// response property for the response status

    • warning

      added the new telegrambot enum value to the /// response property for the response status

    • info

      removed the inapp telegrambot enum value from the /// response property for the response status