Segment GET

GET 
/segments/:segmentId

Required Permissions: Segment Get or Segment Admin

Request

Path Parameters

segmentId integerrequired

The id of the Segment that you wish to get data from.

Responses

200

A JSON Object containing a segment's data.

application/json

Schema

Schema

segment object
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)

{
  "segment": {
    "id": 0,
    "name": "Language",
    "description": "The user's language",
    "value_source_attribute": "language",
    "created_at": "2024-12-02T14:38:57.865Z",
    "created_by_user_id": 0,
    "updated_at": "2024-12-02T14:38:57.865Z",
    "updated_by_user_id": 0,
    "created_by": {
      "archived": false,
      "avatar": {},
      "avatar_file_upload_url": "/cropUrl/100x100/1.png",
      "created_at": "2024-12-02T14:38:57.865Z",
      "created_by_user_id": 0,
      "department": "Marketing",
      "email": "user@example.com"
    }
  }
}

Loading...