> ## Documentation Index
> Fetch the complete documentation index at: https://docs.useboom.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the segment filter catalog

> Everything filterable in your organization — person attributes, related data, and computed variables — with the token and operators to use for each. Read this first when building a filter.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/segments/catalog
openapi: 3.1.0
info:
  title: Boom API
  version: 1.0.0
  description: >-
    Boom's public REST API — one uniform surface over every platform capability.
    CDP: upsert people and custom objects, define object and relationship types,
    link and unlink relationships, and record behavioral events — one record per
    request or up to 1000 per request via the `/batch` endpoints. Segments: read
    (list, read, membership) and full authoring — discover the filterable
    catalog, validate a filter, create and update segments, preview match
    counts, and trigger evaluation. Initiatives: create and configure outreach
    initiatives, link WhatsApp templates, drive the lifecycle (launch, cancel,
    archive), and read collected-data summaries. Participants: enroll people
    into an active initiative, track their status, read conversation
    transcripts, and stop outreach. Journeys: read-only access to always-on
    message flows and their metrics. WhatsApp templates: list your WhatsApp
    numbers and list, read, and create message templates. The same capabilities
    are exposed as MCP tools with identical schemas.
servers:
  - url: https://www.useboom.ai
    description: Production
  - url: https://dev.useboom.ai
    description: Development (sandbox — use a development organization API key)
security:
  - bearerAuth: []
paths:
  /api/v1/segments/catalog:
    get:
      tags:
        - Segments
      summary: Get the segment filter catalog
      description: >-
        Everything filterable in your organization — person attributes, related
        data, and computed variables — with the token and operators to use for
        each. Read this first when building a filter.
      operationId: segments_catalog
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  personAttributes:
                    type: array
                    items:
                      type: object
                      properties:
                        attr:
                          type: string
                          description: >-
                            The exact token to place in a predicate's `attr`
                            field.
                        type:
                          type: string
                          enum:
                            - STRING
                            - NUMBER
                            - BOOLEAN
                            - DATE
                            - JSON
                            - ARRAY
                        operators:
                          type: array
                          items:
                            type: string
                          description: >-
                            Operators valid for this type. Empty for JSON/ARRAY
                            containers — drill into a leaf with `path` first.
                        description:
                          anyOf:
                            - type: string
                            - type: 'null'
                      required:
                        - attr
                        - type
                        - operators
                        - description
                      additionalProperties: false
                    description: Person columns and custom person attributes.
                  computedVariables:
                    type: array
                    items:
                      type: object
                      properties:
                        attr:
                          type: string
                          description: >-
                            The exact token to place in a predicate's `attr`
                            field.
                        type:
                          type: string
                          enum:
                            - STRING
                            - NUMBER
                            - BOOLEAN
                            - DATE
                            - JSON
                            - ARRAY
                        operators:
                          type: array
                          items:
                            type: string
                          description: >-
                            Operators valid for this type. Empty for JSON/ARRAY
                            containers — drill into a leaf with `path` first.
                        description:
                          anyOf:
                            - type: string
                            - type: 'null'
                        label:
                          type: string
                          description: Human-readable label.
                        group:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Grouping label for display.
                      required:
                        - attr
                        - type
                        - operators
                        - description
                        - label
                        - group
                      additionalProperties: false
                  customObjectTypes:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        displayName:
                          anyOf:
                            - type: string
                            - type: 'null'
                        attributes:
                          type: array
                          items:
                            type: object
                            properties:
                              attr:
                                type: string
                                description: >-
                                  The exact token to place in a predicate's
                                  `attr` field.
                              type:
                                type: string
                                enum:
                                  - STRING
                                  - NUMBER
                                  - BOOLEAN
                                  - DATE
                                  - JSON
                                  - ARRAY
                              operators:
                                type: array
                                items:
                                  type: string
                                description: >-
                                  Operators valid for this type. Empty for
                                  JSON/ARRAY containers — drill into a leaf with
                                  `path` first.
                              description:
                                anyOf:
                                  - type: string
                                  - type: 'null'
                            required:
                              - attr
                              - type
                              - operators
                              - description
                            additionalProperties: false
                      required:
                        - name
                        - displayName
                        - attributes
                      additionalProperties: false
                  reachableObjects:
                    type: array
                    items:
                      type: object
                      properties:
                        typeName:
                          type: string
                        paths:
                          type: array
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                customObjectType:
                                  type: string
                                direction:
                                  type: string
                                  enum:
                                    - parent_to_child
                                    - child_to_parent
                                relationshipType:
                                  type: string
                                attributeFilters:
                                  type: array
                                  items: {}
                                  description: >-
                                    Conditions on this hop, in the same shape as
                                    a `has_relationship` `attributeFilters`
                                    entry.
                              required:
                                - customObjectType
                                - attributeFilters
                              additionalProperties: false
                      required:
                        - typeName
                        - paths
                      additionalProperties: false
                      description: >-
                        A related-data type reachable from a person, with every
                        distinct hop-path to it. Use one of the paths as a
                        `has_relationship` predicate `path`.
                  operatorReference:
                    type: array
                    items:
                      type: object
                      properties:
                        operator:
                          type: string
                        takesValue:
                          type: boolean
                          description: Whether the operator expects a `value`.
                        valueShape:
                          type: string
                          enum:
                            - none
                            - scalar
                            - list
                            - date
                            - dateRange
                            - relativeWindow
                            - dateOffset
                          description: The shape the operator's `value` must take.
                        description:
                          type: string
                      required:
                        - operator
                        - takesValue
                        - valueShape
                        - description
                      additionalProperties: false
                required:
                  - personAttributes
                  - computedVariables
                  - customObjectTypes
                  - reachableObjects
                  - operatorReference
                additionalProperties: false
        '400':
          description: Validation failed or the request cannot proceed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '401':
          description: Missing, malformed, or revoked API key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '404':
          description: The resource does not exist in this organization.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '409':
          description: >-
            Conflicts with the current state (duplicates, wrong lifecycle
            state).
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '422':
          description: The request is well-formed but semantically invalid.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '429':
          description: Rate limit exceeded — retry after `Retry-After`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '503':
          description: Transient error — retry with a narrower request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Organization API key, sent as `Authorization: Bearer boom_org_...`.'

````