Skip to main content

Segments LIST‚Äč

Required Permissions: Segment List or Segment Admin

Query Parameters
    sort string

    The object key to sort the results by.

    sort_asc boolean
    page integer
    items integer
Responses

A JSON Object containing an array of all segments.


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-time nullable
    updated_by_user_id integer nullable
    created_by object
    archived boolean
    avatar object nullable
    avatar_file_upload_url string
    created_at date-time
    created_by_user_id integer

    Possible values: >= 1

    department string
    email email
  • ]
Loading...