Segment

  • categories
    Type: array of integer

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

  • created
    Type: stringFormat: date-time
    read-only

    Creation timestamp

  • createdUserId
    Type: integer
    read-only

    ID of user who created this record

  • customModuleId
    Type: integer

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

  • description
    Type: string

    More detailed description of segment

  • filter
    Type: string

    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.

  • id
    Type: integer
    read-only

    Unique identifier - primary key

  • module
    Type: string

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

  • name
    Type: string

    Name of the Segment

  • orderIndex
    Type: integer

    Numeric position used to sort segments in the UI

  • teams
    Type: array of integer

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

  • updated
    Type: stringFormat: date-time
    read-only

    Last edit timestamp

  • updatedUserId
    Type: integer
    read-only

    ID of the user who last edited this record

  • users
    Type: array of integer

    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.