Documentation Index

Fetch the complete documentation index at: https://docs.xtremepush.com/llms.txt

Use this file to discover all available pages before exploring further.

List segments

Prev Next
Post
/list/segment

Used to get a list of segments.

For more information on segments review our segmentation guide.

Body parameters
object
apptoken
string Required

Your App token

limit
integer (int32)

Used with offset for pagination

offset
integer (int32)

Used with limit for pagination

Responses
200

200

Result
{
  "code": "200",
  "success": "True",
  "data": [
    {
      "id": "SEGMENT_ID",
      "title": "Test"
    },
    {
      "id": "SEGMENT_ID",
      "title": "Test 2"
    }
  ]
}
Expand All
object
code
integer
Default0
Example200
success
boolean
Defaulttrue
ExampleTrue
data
Array of object
object
id
string
ExampleSEGMENT_ID
title
string
ExampleTest
conditions
object
400

400

Result
{
  "success": "False",
  "code": "400",
  "message": "General error information",
  "errors": [
    {
      "text": [
        "Detailed information about the specific error"
      ]
    }
  ]
}
Expand All
object
success
boolean
Defaulttrue
ExampleFalse
code
integer
Default0
Example400
message
string
ExampleGeneral error information
errors
Array of object
object
text
Array of string
string