REreteno
Contacts

Get contacts from a segment

Changed on

The method is used to search for all contacts in a segment.

get/api/v1/group/{id}/contacts

Request

Path parameters

idinteger required

Segment ID

Query parameters

startindexinteger

The index of the first contact returned from the search result.<br/>Numbering starts at 1

maxrowsinteger

Maximum number of contacts to return (max. 500)

orderByTsboolean

Order by the time of addition to the segment.

ascboolean

Sort in ascending (ASC) or descending (DESC) order.

Response

firstNamestring

Contact’s first name. <a href="https://docs.reteno.com/docs/contact-fields#first-name">Read more...</a>

lastNamestring

Contact’s last name. <a href="https://docs.reteno.com/docs/contact-fields#last-name">Read more...</a>

addressBookIdinteger

The list of additional contact fields. <a href="https://docs.reteno.com/reference/getaddressbooks-1">Read more...</a>

idinteger

A field containing the internal contact ID in our system. <a href="https://docs.reteno.com/docs/contact-fields#contact-id">Read more...</a>

externalCustomerIdstring

A field containing the internal contact ID in your system. <a href="https://docs.reteno.com/docs/contact-fields#external-id">Read more...</a>

languageCodestring

Language code for the contact. <a href="https://docs.reteno.com/docs/contact-fields#language">Read more...</a>

timeZonestring

The contact's time zone. <a href="https://docs.reteno.com/docs/contact-fields#time-zone">Read more...</a>

marketIdstring

Customer market/region identifier. Optional parameter. Up to 64 characters. Allowed symbols: [a-zA-Z0-9-_]

Example response

[
  {
    "firstName": "John",
    "lastName": "Smith",
    "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"
        }
      }
    ],
    "address": {
      "region": "Occitanie",
      "town": "Toulouse",
      "address": "Rue Imaginaire, 456",
      "postcode": "31000",
      "countryCode": "FR"
    },
    "fields": [
      {
        "id": 79814,
        "value": "textfield"
      }
    ],
    "addressBookId": 7200,
    "id": 23456789,
    "externalCustomerId": "TV12790",
    "groups": [
      {
        "id": 200400
      }
    ],
    "languageCode": "en",
    "timeZone": "Europe/London",
    "marketId": "kyiv"
  }
]

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