> ## 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 contact predictive scores > Return the tenant's per-contact predictive scores — churn risk, intent, propensity, LTV estimate and the derived health `segment_label` — with cursor pagination. Filter by `segment_label` and sort by any score column via `sort` (prefix `-` for descending; default `churn_risk` DESC), so the dashboard "At Risk" and "Champions" panels render without an N+1 back to each contact. On a transient read blip a last-known-good page is served with `meta.degraded: true` rather than a 5xx. ## OpenAPI ````yaml /openapi.yaml get /api/v1/contacts/scores 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/scores: get: tags: - Contacts summary: List contact predictive scores description: >- Return the tenant's per-contact predictive scores — churn risk, intent, propensity, LTV estimate and the derived health `segment_label` — with cursor pagination. Filter by `segment_label` and sort by any score column via `sort` (prefix `-` for descending; default `churn_risk` DESC), so the dashboard "At Risk" and "Champions" panels render without an N+1 back to each contact. On a transient read blip a last-known-good page is served with `meta.degraded: true` rather than a 5xx. parameters: - schema: type: string in: query name: segment_label required: false description: >- Filter to one health segment (champion, high_value_engaged, engaged, new, passive, at_risk, dormant, lost). - schema: type: string in: query name: sort required: false description: Sort column; prefix with `-` for descending (default `-churn_risk`). - 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`. responses: '200': description: >- A page of scored contacts in `data`; the next cursor and any `degraded` flag are in `meta`. content: application/json: schema: type: object additionalProperties: true properties: data: type: array items: type: object additionalProperties: true properties: contact_id: type: string churn_risk: type: number intent_score: type: number propensity_score: type: number ltv_estimate_cents: type: integer segment_label: type: string description: >- Derived health segment (champion, high_value_engaged, engaged, new, passive, at_risk, dormant, lost). signals: type: object additionalProperties: true computed_at: type: string format: date-time display_name: type: - 'null' - string phone: type: - 'null' - string email: type: - 'null' - string meta: type: object additionalProperties: true example: data: - contact_id: contact_01HZX8Y7QJK4M churn_risk: 0.82 intent_score: 0.34 propensity_score: 0.19 ltv_estimate_cents: 480000 segment_label: at_risk computed_at: '2026-02-02T06:00:00.000Z' display_name: Grace Hopper phone: '+14155550142' email: grace@example.com meta: request_id: req_01HZX9ABCDEF timestamp: '2026-02-02T12:00:00.000Z' pagination: cursor: eyJjIjoiMjAyNi0wMiJ9 has_more: true 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_*) ````