Skip to main content

List Segments

GET 

/segments

This API returns a list of all segments. A token with ORG_ADMIN or API authority is required to call this API.

Request

Query Parameters

    limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
    offset int32

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Example: 0
    count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true

Responses

List of all segments

Schema
  • Array [
  • id string

    The segment's ID.

    name string

    The segment's business name.

    created date-time

    The time when the segment is created.

    modified date-time

    The time when the segment is modified.

    description string

    The segment's optional description.

    owner objectnullable

    The owner of this object.

    type string

    Possible values: [IDENTITY]

    Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.

    id string

    Identity id

    name string

    Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.

    visibilityCriteria object
    expression object
    operator string

    Possible values: [AND, EQUALS]

    Operator for the expression

    attribute stringnullable

    Name for the attribute

    value objectnullable
    type string

    The type of attribute value

    value string

    The attribute value

    children object[]nullable

    List of expressions

  • Array [
  • operator string

    Possible values: [AND, EQUALS]

    Operator for the expression

    attribute stringnullable

    Name for the attribute

    value objectnullable
    type string

    The type of attribute value

    value string

    The attribute value

    children stringnullable

    There cannot be anymore nested children. This will always be null.

  • ]
  • active boolean

    Default value: false

    This boolean indicates whether the segment is currently active. Inactive segments have no effect.

  • ]
Loading...