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

# Audience filters

> Audience filters using the public Orbit API



## OpenAPI

````yaml https://api.aws53.cloud/openapi-intent.json GET /v1/intent/audiences/filters
openapi: 3.1.0
info:
  title: Orbit API
  version: 1.0.0
  description: >-
    Orbit Audience Intent API: topic discovery, site analysis, curated ICP
    filters, saved audiences, materialization runs, stats, and CSV export.
    Discovery endpoints are public; audience management accepts either Bearer
    JWT or X-API-Key auth.
servers:
  - url: https://api.aws53.cloud
    description: Production
security: []
tags:
  - name: Topic Discovery
    description: Browse, search, and analyze available intent topics
  - name: Site Analysis
    description: Analyze a website URL to find matching intent topics
  - name: Site Topics
    description: Recent organization site-topic analyses
  - name: Audience Builder
    description: >-
      Curated filters, preview, saved audiences, runs, exports, webhooks, and
      managed destinations
paths:
  /v1/intent/audiences/filters:
    get:
      tags:
        - Audience Builder
      summary: Get available audience filter definitions
      description: >-
        Returns the public Orbit audience filter catalog, including supported
        operators, UI hints, available values, and approximate counts. This
        public operation allows 2 requests per source IP per 60 seconds without
        valid authentication, or 200 with a valid bearer token or active
        organization API key.
      operationId: getAvailableAudienceFilterDefinitions
      responses:
        '200':
          description: Audience filter catalog
          headers:
            RateLimit-Limit:
              description: Maximum requests allowed per source IP in 60 seconds.
              schema:
                type: integer
                example: 2
            RateLimit-Remaining:
              description: Requests remaining in the current source-IP window.
              schema:
                type: integer
                example: 0
            RateLimit-Reset:
              description: Seconds until the current source-IP window resets.
              schema:
                type: integer
                example: 60
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudienceFilterCatalogResponse'
              example:
                data:
                  version:
                    status: catalog
                    sourceTable: example_profiles
                    catalogTable: example_filter_catalog
                    catalogVersion: example-v1
                    buildId: example-build
                    buildDate: '2026-01-15'
                    generatedAt: '2026-01-15T12:00:00.000Z'
                  summary:
                    groupCount: 1
                    filterCount: 1
                    valueCount: 1
                    recommendedFilterCount: 1
                    standardFilterCount: 0
                    advancedFilterCount: 0
                    supportsAdvancedLogic: true
                    defaultFieldLogic: and
                  logic:
                    summary: >-
                      Use keys from groups[].filters[].key inside audience
                      config.filters. Simple top-level filters are combined with
                      AND. Advanced filters support explicit and/or groups.
                    uiHints:
                      useFields:
                        - key
                        - label
                        - ui
                        - type
                        - valueType
                        - operators
                        - values
                        - maxValues
                        - maxTerms
                        - min
                        - max
                      technicalFields:
                        - sourceColumn
                        - source
                        - requiresSidecar
                      valueHint: >-
                        Use values when present for dropdowns. Search-only text
                        filters intentionally do not include values.
                    simpleFilters:
                      shape: >-
                        { "filters": { "<group>": { "<field>": <value> } } } or
                        { "filters": { "<filter.key>": <value> } }
                      topLevelLogic: AND across different filters.
                      multiSelectValueLogic: OR within values for one multi_select filter.
                      textTermLogic: >-
                        text_terms use mode/includeMode "any" for OR or "all"
                        for AND. jobTitle.exclude and negate=true invert the
                        match.
                    advancedFilters:
                      enabled: true
                      keys:
                        - and
                        - or
                      conditionShape: >-
                        { "field": "<filter.key>", "value": <value> } or {
                        "field": "<filter.key>", "values": [<value>] }
                      rules:
                        - >-
                          A group can contain either and or or at the same
                          level, not both.
                        - >-
                          Top-level simple filters and top-level and/or groups
                          are combined with AND.
                        - >-
                          Nested OR groups cannot mix serving-only and
                          filter-surface-only filters.
                        - >-
                          Nested AND groups cannot mix serving-only and
                          filter-surface-only filters; put those filters at top
                          level instead.
                    examples:
                      simple:
                        company:
                          industries:
                            - software development
                      or:
                        or:
                          - field: company.industries
                            values:
                              - software development
                          - field: company.isSaas
                            value: true
                      nested:
                        and:
                          - field: contact.hasBusinessEmail
                            value: true
                          - or:
                              - field: company.industries
                                values:
                                  - software development
                              - field: company.isSaas
                                value: true
                  groups:
                    - key: company
                      label: Company
                      description: Company attributes
                      filters:
                        - key: company.industries
                          label: Industry
                          type: multi_select
                          valueType: enum
                          operators:
                            - in
                          sourceColumn: company_industry
                          source: both
                          requiresSidecar: false
                          isSearchOnly: false
                          maxValues: 500
                          ui:
                            label: Industry
                            description: Company industry
                            control: multi_select
                            section: recommended
                            order: 10
                            recommended: true
                            advanced: false
                          values:
                            - value: software development
                              label: Software Development
                              count: 120
                meta:
                  timestamp: '2026-01-15T12:00:00.000Z'
                  request_id: example-request
        '429':
          description: >-
            Source-IP allowance exceeded: 2 requests per 60 seconds without
            valid authentication, or 200 with a valid bearer token or active
            organization API key.
          headers:
            RateLimit-Limit:
              description: Maximum requests allowed per source IP in 60 seconds.
              schema:
                type: integer
                example: 2
            RateLimit-Remaining:
              description: Requests remaining in the current source-IP window.
              schema:
                type: integer
                example: 0
            RateLimit-Reset:
              description: Seconds until the current source-IP window resets.
              schema:
                type: integer
                example: 60
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                example: 60
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details: {}
                    required:
                      - code
                      - message
                  meta:
                    type: object
                    properties:
                      timestamp:
                        type: string
                      request_id:
                        type: string
                    required:
                      - timestamp
                      - request_id
                required:
                  - error
                  - meta
              example:
                error:
                  code: RATE_LIMIT_EXCEEDED
                  message: Too many requests, please try again later
                meta:
                  timestamp: '2026-01-15T12:00:00.000Z'
                  request_id: example-request
      security: []
components:
  schemas:
    AudienceFilterCatalogResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            version:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - catalog
                    - static_fallback
                sourceTable:
                  type: string
                catalogTable:
                  type: string
                catalogVersion:
                  type:
                    - string
                    - 'null'
                buildId:
                  type:
                    - string
                    - 'null'
                buildDate:
                  type:
                    - string
                    - 'null'
                generatedAt:
                  type:
                    - string
                    - 'null'
              required:
                - status
                - sourceTable
                - catalogTable
                - catalogVersion
                - buildId
                - buildDate
                - generatedAt
            summary:
              type: object
              properties:
                groupCount:
                  type: number
                filterCount:
                  type: number
                valueCount:
                  type: number
                recommendedFilterCount:
                  type: number
                standardFilterCount:
                  type: number
                advancedFilterCount:
                  type: number
                supportsAdvancedLogic:
                  type: boolean
                defaultFieldLogic:
                  type: string
                  enum:
                    - and
              required:
                - groupCount
                - filterCount
                - valueCount
                - recommendedFilterCount
                - standardFilterCount
                - advancedFilterCount
                - supportsAdvancedLogic
                - defaultFieldLogic
            logic:
              type: object
              properties:
                summary:
                  type: string
                uiHints:
                  type: object
                  properties:
                    useFields:
                      type: array
                      items:
                        type: string
                    technicalFields:
                      type: array
                      items:
                        type: string
                    valueHint:
                      type: string
                  required:
                    - useFields
                    - technicalFields
                    - valueHint
                simpleFilters:
                  type: object
                  properties:
                    shape:
                      type: string
                    topLevelLogic:
                      type: string
                    multiSelectValueLogic:
                      type: string
                    textTermLogic:
                      type: string
                  required:
                    - shape
                    - topLevelLogic
                    - multiSelectValueLogic
                    - textTermLogic
                advancedFilters:
                  type: object
                  properties:
                    enabled:
                      type: boolean
                    keys:
                      type: array
                      items:
                        type: string
                        enum:
                          - and
                          - or
                    conditionShape:
                      type: string
                    rules:
                      type: array
                      items:
                        type: string
                  required:
                    - enabled
                    - keys
                    - conditionShape
                    - rules
                examples:
                  type: object
                  properties:
                    simple:
                      type: object
                      additionalProperties: {}
                    or:
                      type: object
                      additionalProperties: {}
                    nested:
                      type: object
                      additionalProperties: {}
                  required:
                    - simple
                    - or
                    - nested
              required:
                - summary
                - uiHints
                - simpleFilters
                - advancedFilters
                - examples
            groups:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                  label:
                    type: string
                  description:
                    type: string
                  filters:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                        label:
                          type: string
                        type:
                          type: string
                          enum:
                            - multi_select
                            - boolean
                            - text_terms
                            - number_range
                        valueType:
                          type: string
                          enum:
                            - enum
                            - boolean
                            - string
                            - number
                        operators:
                          type: array
                          items:
                            type: string
                        sourceColumn:
                          type: string
                        source:
                          type: string
                          enum:
                            - serving
                            - filter_surface
                            - both
                        requiresSidecar:
                          type: boolean
                        isSearchOnly:
                          type: boolean
                        maxValues:
                          type: number
                        maxTerms:
                          type: number
                        min:
                          type: number
                        max:
                          type: number
                        ui:
                          type: object
                          properties:
                            label:
                              type: string
                            description:
                              type: string
                            control:
                              type: string
                              enum:
                                - multi_select
                                - toggle
                                - text_chips
                                - number_range
                            section:
                              type: string
                              enum:
                                - recommended
                                - standard
                                - advanced
                            order:
                              type: number
                            recommended:
                              type: boolean
                            advanced:
                              type: boolean
                            placeholder:
                              type: string
                            helperText:
                              type: string
                            examples:
                              type: array
                              items:
                                type: string
                            valueLabelStyle:
                              type: string
                              enum:
                                - title
                                - code
                                - range
                                - grade
                            allowCustomValues:
                              type: boolean
                          required:
                            - label
                            - description
                            - control
                            - section
                            - order
                            - recommended
                            - advanced
                        values:
                          type: array
                          items:
                            type: object
                            properties:
                              value:
                                type: string
                              label:
                                type: string
                              count:
                                type: number
                            required:
                              - value
                              - label
                              - count
                      required:
                        - key
                        - label
                        - type
                        - valueType
                        - operators
                        - sourceColumn
                        - source
                        - requiresSidecar
                        - isSearchOnly
                        - ui
                required:
                  - key
                  - label
                  - description
                  - filters
          required:
            - version
            - summary
            - logic
            - groups
        meta:
          type: object
          properties:
            timestamp:
              type: string
            request_id:
              type: string
          required:
            - timestamp
            - request_id
      required:
        - data
        - meta

````