Segments

Get a segment by ID

get/segment/{segmentId}

Request

  • Base URL: https://test.boost.space/api
  • URL: https://test.boost.space/api/segment/{segmentId}
  • Auth: HTTP bearer

Path parameters

segmentIdinteger required

ID of segment

Response

Segment - Get record

idinteger

Unique identifier - primary key

createdstring date-time

Creation timestamp

createdUserIdinteger

ID of user who created this record

updatedstring date-time

Last edit timestamp

updatedUserIdinteger

ID of the user who last edited this record

namestring

Name of the Segment

descriptionstring

More detailed description of segment

filterstring

Filter expression selecting the records that belong to this segment. Not JSON - it is the same string grammar as the filter query parameter of the record list endpoints, documented there in full: field operator value terms joined with &/; (AND) or | (OR), groups in parentheses, and the same operators (=, !=, >, >=, <, <=, ~/!~ LIKE with % wildcards, ... for an IN set). Example: (name~%acme%&statusId...1,2,3)|spaceId=5.

modulestring

Module this segment applies to (e.g. 'contact', 'deal'); must match a value from the modules table

orderIndexinteger

Numeric position used to sort segments in the UI

customModuleIdinteger

ID of the custom module when the segment targets a custom module instead of a built-in one

usersinteger[]

User IDs the segment is assigned to. Part of the segment's audience together with teams and categories: leaving all three empty makes the segment readable by everyone and editable or deletable only by an administrator, while any non-empty audience restricts it to its members.

teamsinteger[]

Team IDs the segment is assigned to. Part of the segment's audience - see users.

categoriesinteger[]

Category IDs the segment is assigned to. Part of the segment's audience - see users.

Example response

{
  "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
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.