List segments

​

Query Parameters

  • filter
    Type: string

    Filter expression to narrow results. Format: field operator value. Multiple conditions are joined with ; or & (AND) or | (OR). Conditions can be grouped with parentheses. Supported operators: = (equals; also matches NULL when value is empty), != (not equals), >, >=, <, <=, ~ (LIKE, use % as wildcard; empty value matches NULL/empty), !~ (NOT LIKE), ... (IN set, comma-separated: statusId...1,2,3). OR across values for one field: status=(active|pending). Examples: filter=name=Acme, filter=created>=2024-01-01;assigneeId=, filter=name~%smith%;statusId...1,2,3, filter=(status=active|status=pending)&spaceId=5.

  • offset
    Type: integer
    min:  
    0

    Zero-based index of the first record to return. Use together with limit for pagination. Example: offset=20&limit=10 returns records 21–30.

  • limit
    Type: integer
    min:  
    1

    Maximum number of records to return. Use together with offset for pagination.

  • order
    Type: string

    Sort order for results. Comma-separated list of field;DIRECTION pairs. Direction is ASC or DESC (default DESC when omitted). Example: order=name;ASC or order=id;ASC,name;DESC.

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/segment
curl https://test.boost.space/api/segment \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

[
  {
    "id": 42,
    "created": "2026-01-15T09:30:00Z",
    "createdUserId": 42,
    "updated": "2026-01-15T09:30:00Z",
    "updatedUserId": 42,
    "name": "Sample name",
    "description": "string",
    "filter": "string",
    "module": "string",
    "orderIndex": 1,
    "customModuleId": 42,
    "users": [
      1
    ],
    "teams": [
      1
    ],
    "categories": [
      1
    ]
  }
]

Segment records list