MEmessangi
Segments

List segment contacts

Changed on

Requires authentication — see Authentication.

Retrieves the contacts from a certain segment of a list previously created.

get/v3/lists/{listId}/segments/{segmentId}/subscribers

Request

  • Base URL
    https://elastic.messangi.me/qarth
  • URL
    https://elastic.messangi.me/qarth/v3/lists/{listId}/segments/{segmentId}/subscribers
  • Auth
    HTTP bearer

Path parameters

listIdinteger required

Provide the unique ID of the list

segmentIdstring required

Provide the unique ID of the segment

Query parameters

limitinteger

Use limit operator to limit the number of records returned

skipinteger

Use skip operator to skip the specified number of records.

offsetstring

Use offset operator to search the next record to be consulted

sortstring

Useful to sort returned records

selectstring

Useful to limit fields to return in each records

Response

Successfully retrieved the contacts from a segment of a list

Example response

{
  "meta": {
    "timestamp": 1597166699457,
    "transactionId": "70169d77-c165-4795-9932-35b8a3af96fb",
    "explain": "a descriptive text"
  },
  "pagination": {
    "offset": "e3293115e2ec5f466c67e047",
    "limit": 6,
    "next": "5f466c67e047e3293115e2ec",
    "page": 1,
    "pages": 10,
    "total": 1000
  },
  "items": [
    {
      "data": {
        "address": "12345",
        "member since": "2020-10-05T13:09:10.233573Z",
        "last updated": "2020-10-05T13:09:10.233573Z",
        "mobile": "unknown.5f7b1af6535f6b5151040776",
        "id": "5f7b1af6535f6b5151040776",
        "email": "The Tester"
      }
    }
  ]
}

Changes

  • 47d573a56b26Revision changes
    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status