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

# List a tenant's contact segments

> Return the tenant's contact segments using opaque cursor pagination (`limit`, `cursor`), each row carrying its cached `contact_count`. An optional `search` query parameter filters by name/description (trimmed, ≤200 chars, blank = no filter) so the Segments dashboard tab offers the same server-side search box as its sibling Audience tabs. Pagination metadata is returned under `meta.pagination`.



## OpenAPI

````yaml /openapi.yaml get /api/v1/contacts/segments
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
  - name: Risk
    description: >-
      Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
      URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
      composite verdict queryable before a send or a call.
  - name: Orby
    description: >-
      In-dashboard Orby operator assistant: streamed assistant turns,
      conversation threads, product knowledge-base search, and the tool-action
      approval gate. Available to signed-in operators only (dashboard session
      auth — API-key requests are rejected).
paths:
  /api/v1/contacts/segments:
    get:
      tags:
        - Contacts
      summary: List a tenant's contact segments
      description: >-
        Return the tenant's contact segments using opaque cursor pagination
        (`limit`, `cursor`), each row carrying its cached `contact_count`. An
        optional `search` query parameter filters by name/description (trimmed,
        ≤200 chars, blank = no filter) so the Segments dashboard tab offers the
        same server-side search box as its sibling Audience tabs. Pagination
        metadata is returned under `meta.pagination`.
      parameters:
        - schema:
            type: string
          in: query
          name: search
          required: false
          description: Filter by name/description (trimmed, ≤200 chars, blank = no filter).
        - schema:
            type: integer
            minimum: 1
            maximum: 100
          in: query
          name: limit
          required: false
          description: Page size (1-100, default 25).
        - schema:
            type: string
          in: query
          name: cursor
          required: false
          description: Opaque pagination cursor from a previous page's `meta.pagination`.
      responses:
        '200':
          description: >-
            A page of segment rows in `data`, with `meta.pagination` for the
            next cursor.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
                  meta:
                    type: object
                    additionalProperties: true
              example:
                data:
                  - id: segment_01HZX7SEG9KJ4
                    name: High-value EU customers
                    description: Customers in the EU with lifetime value over €1,000.
                    contact_count: 1284
                    auto_refresh: true
                    created_at: '2026-01-20T08:00:00.000Z'
                meta:
                  request_id: req_01HZX9ABCDEF
                  timestamp: '2026-02-02T12:00:00.000Z'
                  pagination:
                    cursor: eyJzIjoiMjAyNi0wMSJ9
                    has_more: true
                    total: 37
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````