Segments LIST

GET 
/segments

Required Permissions: Segment List or Segment Admin

Request

Query Parameters

sort string

The object key to sort the results by.

sort_asc boolean
page integer
items integer

Responses

200

A JSON Object containing an array of all segments.

application/json

Schema

Schema

items integer
page integer

Possible values: >= 1

total integer
segments object[]
Array [
id integer
name string
description string
value_source_attribute string
created_at date-time
created_by_user_id integer
updated_at date-timenullable
updated_by_user_id integernullable
created_by object
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
]

Example (from schema)

{
  "items": 0,
  "page": 0,
  "total": 0,
  "segments": [
    {
      "id": 0,
      "name": "Language",
      "description": "The user's language",
      "value_source_attribute": "language",
      "created_at": "2024-10-14T16:22:32.703Z",
      "created_by_user_id": 0,
      "updated_at": "2024-10-14T16:22:32.703Z",
      "updated_by_user_id": 0,
      "created_by": {
        "archived": false,
        "avatar": {},
        "avatar_file_upload_url": "/cropUrl/100x100/1.png",
        "created_at": "2024-10-14T16:22:32.703Z",
        "created_by_user_id": 0,
        "department": "Marketing",
        "email": "[email protected]"
      }
    }
  ]
}

Loading...