Get persons in a segment

Use this method to get persons in a segment by ID.

get/people/3/segments/{segmentId}/persons

Request

Base URL
https://api.infobip.com (the document declares no server; this is the origin it was published from)
Auth
- OAuth 2
  Client credentials
  Token URL: https://api.infobip.com/auth/1/oauth2/token
- or API key in header Authorization
- or API key in header Authorization
- or HTTP basic

Path parameters

segmentIdinteger required

A unique segment identifier.

Example:42

Query parameters

pageinteger

Zero-based page index (0..N).

sizeinteger

The size of the page to be returned.

sortstring[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

[
  "name,DESC"
]

Response

Example response

{
  "results": [
    {
      "id": 1,
      "externalId": "3",
      "type": "CUSTOMER",
      "firstName": "Jane",
      "middleName": "Janie",
      "lastName": "Smith",
      "nickName": "Janey",
      "country": "United Kingdom",
      "city": "London",
      "address": "67 Farringdon Road",
      "gender": "FEMALE",
      "preferredLanguage": "en-gb",
      "birthDate": "1966-01-15",
      "profilePicture": "http://profile.com",
      "tags": [
        "tag1",
        "tag2"
      ],
      "contactInformation": [
        {
          "type": "PHONE",
          "identifier": "41793026727",
          "sender": "41793026728",
          "primary": true
        }
      ],
      "customAttributes": {
        "Contract Expiry": "2024-06-12",
        "Company": "ACME"
      },
      "computedAttributes": {
        "fullName": "Jane Smith"
      },
      "createdFrom": "API",
      "createdBy": "5",
      "modifiedFrom": "API",
      "modifiedBy": "5"
    }
  ]
}

Changes

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