> ## 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 contacts

> Retrieve contacts with cursor-based pagination, search, and filtering.



## OpenAPI

````yaml /openapi.yaml get /api/v1/contacts/
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
paths:
  /api/v1/contacts/:
    get:
      tags:
        - Contacts
      summary: List contacts
      description: Retrieve contacts with cursor-based pagination, search, and filtering.
      parameters:
        - schema:
            type: string
          in: query
          name: cursor
          required: false
          description: >-
            Opaque cursor for the next page (from previous response
            meta.pagination.cursor)
        - schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 25
          in: query
          name: limit
          required: false
          description: Number of items per page (1–200, default 25)
        - schema:
            type: string
          in: query
          name: search
          required: false
          description: Free-text search across name, phone, email
        - schema:
            type: string
          in: query
          name: lifecycle_stage
          required: false
          description: Filter by lifecycle stage
        - schema:
            type: string
          in: query
          name: country_code
          required: false
          description: Filter by country code
        - schema:
            type: string
          in: query
          name: tags
          required: false
          description: Comma-separated tag filter
        - schema:
            type: boolean
          in: query
          name: has_phone
          required: false
          description: Only contacts with a phone number
        - schema:
            type: boolean
          in: query
          name: has_email
          required: false
          description: Only contacts with an email address
        - schema:
            type: string
            format: date-time
          in: query
          name: created_after
          required: false
          description: Created after this date
        - schema:
            type: string
            format: date-time
          in: query
          name: created_before
          required: false
          description: Created before this date
      responses:
        '200':
          description: Paginated list of contacts
          content:
            application/json:
              schema:
                type: object
                description: Paginated list of contacts
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
                      properties:
                        id:
                          type: string
                        phone:
                          type:
                            - 'null'
                            - string
                        email:
                          type:
                            - 'null'
                            - string
                        first_name:
                          type:
                            - 'null'
                            - string
                        last_name:
                          type:
                            - 'null'
                            - string
                        company:
                          type:
                            - 'null'
                            - string
                        country_code:
                          type:
                            - 'null'
                            - string
                        language:
                          type:
                            - 'null'
                            - string
                        avatar_url:
                          type:
                            - 'null'
                            - string
                        tags:
                          type: array
                          items:
                            type: string
                        lifecycle_stage:
                          type:
                            - 'null'
                            - string
                        custom_attributes:
                          type:
                            - 'null'
                            - object
                          additionalProperties: true
                        total_messages_sent:
                          type:
                            - 'null'
                            - integer
                        total_messages_received:
                          type:
                            - 'null'
                            - integer
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type:
                            - 'null'
                            - string
                          format: date-time
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
                      pagination:
                        type: object
                        properties:
                          cursor:
                            type: string
                            nullable: true
                            description: >-
                              Opaque cursor to fetch the next page (null when no
                              more pages)
                          has_more:
                            type: boolean
                            description: Whether more results exist beyond this page
                          total:
                            type: integer
                            description: Total number of items matching the query
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_*)

````