> ## 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 messages > Retrieve messages with cursor-based pagination and optional channel/status filters. ## OpenAPI ````yaml /openapi.yaml get /api/v1/messages/ 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/messages/: get: tags: - Messages summary: List messages description: >- Retrieve messages with cursor-based pagination and optional channel/status filters. 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 enum: - sms - whatsapp - email - rcs - viber - voice - fax - instagram - messenger - line - push - telegram in: query name: channel required: false description: Filter by channel - schema: type: string enum: - pending - queued - scheduled - accepted - sending - sent - delivered - submitted_no_receipt - read - failed - rejected - undelivered - bounced - expired - suppressed - test_sent - cancelled - deleted - unknown in: query name: status required: false description: >- Filter by delivery status. Accepts every status the messages.status column can hold across all channels — DAG states (pending/queued/scheduled/accepted/sending/sent), terminal successes (delivered/submitted_no_receipt/read), failure modes (failed/rejected/undelivered/bounced/expired), and operational sentinels (suppressed/test_sent/deleted/unknown). Email spam complaints are not a distinct status — a complaint DLR is recorded as status=failed with metadata.complaint_type set to "spam_report". To isolate complaint-driven failures, filter on status=failed and inspect metadata.complaint_type. - schema: type: string maxLength: 100 in: query name: to required: false description: Filter by recipient - schema: type: string enum: - inbound - outbound in: query name: direction required: false description: Filter by direction - schema: type: string maxLength: 100 in: query name: contact_id required: false description: Filter by contact - schema: type: string maxLength: 10 in: query name: dateRange required: false description: Date range filter (e.g. 7d, 30d, 90d) - schema: anyOf: - type: string format: date-time - type: string format: date in: query name: from_date required: false description: Custom date range start (ISO 8601 date or date-time) - schema: anyOf: - type: string format: date-time - type: string format: date in: query name: to_date required: false description: Custom date range end (ISO 8601 date or date-time) - schema: type: string maxLength: 100 in: query name: conversation_id required: false description: Filter by conversation - schema: type: string enum: - conversation - contact - channel in: query name: groupBy required: false description: Group results responses: '200': description: Paginated list of messages content: application/json: schema: type: object description: Paginated list of messages properties: data: type: array items: type: object additionalProperties: true properties: id: type: string channel: type: string direction: type: string from: type: - 'null' - string to: type: - 'null' - string body: type: - 'null' - string media_url: type: - 'null' - string status: type: string segments: type: - 'null' - integer price: type: - 'null' - string - number currency: type: - 'null' - string provider: type: - 'null' - string external_id: type: - 'null' - string error_code: type: - 'null' - string error_message: type: - 'null' - string contact_id: type: - 'null' - string metadata: type: - 'null' - object additionalProperties: true mccmnc: type: - 'null' - string sent_at: type: - 'null' - string format: date-time delivered_at: type: - 'null' - string format: date-time read_at: type: - 'null' - string format: date-time failed_at: type: - 'null' - string format: date-time 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_*) ````