Pre-release — content may change.

Segments

List segment filters

GET
/segment_filters

A paginated list of segment filters visible to the current user. Served from the /segment_filters route (JSON:API type: segment_filters).

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

include?string

Comma-separated list of relationships to include. Allowed values are resource-specific; consult the operation for the allowlist.

sort?string

Comma-separated list of attributes to sort by. Prefix with - for descending order (-created_at,family_name).

page?

Offset pagination parameters.

filter?

Keys take the form filter[<attribute>_<predicate>]=<value>, repeatable per query.

Common predicates by attribute type:

  • String / text / uuid: eq, not_eq, cont, not_cont, matches, start, end, present, blank, null, not_null, in, not_in
  • Integer / decimal / date / datetime: eq, not_eq, gt, gteq, lt, lteq, present, blank, null, not_null, in, not_in
  • Boolean: eq, not_eq, present, blank, null, not_null

Example: ?filter[state_eq]=processed&filter[entity_eq]=people

fields[segment_filters]?array<>

Sparse-fieldset selection.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/segment_filters"
{  "data": [    {      "type": "segment_filters",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "attributes": {        "title": "string",        "description": "string",        "state": "draft",        "filters": {},        "entity": "people",        "segment_type": "static",        "access": "only_me",        "records_count": 0,        "has_automations": true,        "category": "string",        "updated_at": "2019-08-24T14:15:22Z"      },      "relationships": {        "created_by": {          "data": null,          "links": {            "self": "/segment_filters/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/created_by"          }        },        "links": {}      },      "meta": {        "resource_added_at": "2019-08-24T14:15:22Z",        "can_manage": true      },      "links": {        "self": "/segment_filters/7247ad7d-9275-454b-9e3a-0570e403739e"      }    }  ],  "meta": {    "page": {      "total_items": 0,      "total_pages": 0,      "number": 0,      "size": 0    }  }}
{  "errors": [    {      "status": 0,      "title": "string",      "source": {        "pointer": "string",        "parameter": "string"      },      "meta": {        "error": "string",        "field": "string"      }    }  ]}
{  "errors": [    {      "status": 0,      "title": "string",      "source": {        "pointer": "string",        "parameter": "string"      },      "meta": {        "error": "string",        "field": "string"      }    }  ]}