Skip to main content

Segment GET‚Äč

Required Permissions: Segment Get or Segment Admin

Path Parameters
    segmentId integer required

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

Responses

A JSON Object containing a segment's data.


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-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...