INinfobip
customer-engagement
people
segments

Get a list of segments

Use this method to get a list of segments.

get/people/3/segments

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

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

OK

Example response

{
  "results": [
    {
      "id": 42,
      "name": "VIP Alex Clients",
      "description": "Persons named Alex with tag \"VIP Client\"",
      "query": {
        "#and": [
          {
            "firstName": "Alex"
          },
          {
            "#contains": {
              "tags": "VIP Client"
            }
          }
        ]
      },
      "events": [
        {
          "definitionId": "addedToCart",
          "occurrenceCondition": {
            "operation": "IS",
            "times": 5
          },
          "timelineCondition": {
            "occurred": "ALL",
            "operator": "BETWEEN",
            "start": 60,
            "end": 30,
            "units": "DAYS"
          },
          "payloadConditions": [
            {
              "attribute": "itemId",
              "operator": "EQ",
              "value": "10001"
            }
          ]
        }
      ]
    }
  ]
}

Changes

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