vCita Contact Channels API

Operations for retrieving contact-level channel availability

GitHub OpenAPI

Operations 1

GET /v3/communication/contact_channels Get All ContactChannels #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/vcita:vcita-contact-channels-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

vcita-contact-channels-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Communication Contact Channels API
  description: Unified OpenAPI specification for communication domain
  version: '3.0'
  x-generated:
    sourceFiles:
    - contact_channels.json
    - communication.json
    - staff_notification.json
    - business_phone_numbers.json
    - legacy_v1_communication.json
    - activity_message.json
    - communication.json
    - conversations.json
    - notification_template.json
    - legacy_v2_communication.json
    - messages.json
    pathNormalizations:
    - file: communication.json
      basePath: /business/communication
      transformations:
      - original: /channels
        normalized: /business/communication/channels
        basePath: /business/communication
      - original: /channels/{uid}
        normalized: /business/communication/channels/{uid}
        basePath: /business/communication
      - original: /messages
        normalized: /business/communication/messages
        basePath: /business/communication
      - original: /messages/{messageUid}
        normalized: /business/communication/messages/{messageUid}
        basePath: /business/communication
      - original: /sessions
        normalized: /business/communication/sessions
        basePath: /business/communication
      - original: /sessions/typing
        normalized: /business/communication/sessions/typing
        basePath: /business/communication
      - original: /sessions/{uid}
        normalized: /business/communication/sessions/{uid}
        basePath: /business/communication
    - file: legacy_v1_communication.json
      basePath: /platform/v1
      transformations:
      - original: /conversations
        normalized: /platform/v1/conversations
        basePath: /platform/v1
      - original: /clients/{client_id}/conversations
        normalized: /platform/v1/clients/{client_id}/conversations
        basePath: /platform/v1
      - original: /messages
        normalized: /platform/v1/messages
        basePath: /platform/v1
      - original: /numbers/dedicated_numbers/assign
        normalized: /platform/v1/numbers/dedicated_numbers/assign
        basePath: /platform/v1
      - original: /numbers/dedicated_numbers/set_two_way_texting_status
        normalized: /platform/v1/numbers/dedicated_numbers/set_two_way_texting_status
        basePath: /platform/v1
      - original: /numbers/twilio
        normalized: /platform/v1/numbers/twilio
        basePath: /platform/v1
      - original: /numbers/twilio/{sub_account_id}
        normalized: /platform/v1/numbers/twilio/{sub_account_id}
        basePath: /platform/v1
    - file: conversations.json
      basePath: /v2
      transformations:
      - original: /conversations/{id}
        normalized: /v2/conversations/{id}
        basePath: /v2
    - file: legacy_v2_communication.json
      basePath: /v2
      transformations:
      - original: /conversations/{conversation_id}/messages
        normalized: /v2/conversations/{conversation_id}/messages
        basePath: /v2
    - file: messages.json
      basePath: /business/messaging
      transformations:
      - original: /v1/channels
        normalized: /business/messaging/v1/channels
        basePath: /business/messaging
      - original: /v1/channels/typing
        normalized: /business/messaging/v1/channels/typing
        basePath: /business/messaging
    pathConflicts: []
    componentConflicts:
    - type: schema
      name: ErrorResponse
      resolution: Renamed to ErrorResponse_communication
      files:
      - merged
      - communication.json
    - type: schema
      name: ErrorResponse
      resolution: Renamed to ErrorResponse_staff_notification
      files:
      - merged
      - staff_notification.json
    - type: schema
      name: Response
      resolution: Renamed to Response_business_phone_numbers
      files:
      - merged
      - business_phone_numbers.json
    - type: schema
      name: ErrorResponse
      resolution: Renamed to ErrorResponse_business_phone_numbers
      files:
      - merged
      - business_phone_numbers.json
    - type: schema
      name: ErrorResponse
      resolution: Renamed to ErrorResponse_activity_message
      files:
      - merged
      - activity_message.json
    - type: schema
      name: Response
      resolution: Renamed to Response_communication
      files:
      - merged
      - communication.json
    - type: schema
      name: ErrorResponse
      resolution: Renamed to ErrorResponse_conversations
      files:
      - merged
      - conversations.json
    totalPaths: 36
    totalComponents: 50
servers:
- url: https://api.vcita.biz
  description: Unified API Gateway server
tags:
- name: Contact Channels
  description: Operations for retrieving contact-level channel availability
paths:
  /v3/communication/contact_channels:
    get:
      operationId: ContactChannelsController_index
      summary: Get All ContactChannels
      description: '## Overview

        Returns the contact-level availability of every communication channel the business has (email, SMS, and installed third-party apps) for a single contact. Each entry reports whether the contact can be reached on that channel and, when not, a machine-readable reason. Each entry also carries the contact''s destination on the channel (`channel_path`) and whether it is the contact''s primary channel (`primary`).


        The business is resolved from the caller''s staff context; the contact must belong to that business. Staff restricted to their own clients get a 404 for contacts they are not assigned to or collaborating on.


        Available for **Staff Tokens**'
      parameters:
      - name: contact_uid
        required: true
        in: query
        schema:
          type: string
        description: Unique identifier of the contact (client) to evaluate channel availability for (e.g., "peu8ljecwqr5ok58").
      responses:
        '200':
          description: Contact channel availability retrieved successfully
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    success:
                      type: boolean
                      description: Indicates whether the API request was successful (true) or failed (false).
                    data:
                      type: object
                      description: 'The response payload. Present on successful responses (success: true).'
                    error:
                      type: string
                      description: Error message for simple error responses. Used in some legacy endpoints.
                    errors:
                      type: array
                      description: 'Array of error objects for detailed error responses. Present on error responses (success: false).'
                      items:
                        type: object
                        properties:
                          code:
                            type: string
                            description: Machine-readable error code (e.g., 'already_exists', 'invalid', 'not_found').
                          message:
                            type: string
                            description: Human-readable error message.
                          field:
                            type: string
                            description: The field that caused the error (for validation errors).
                        required:
                        - code
                        - message
                  required:
                  - success
                  description: Generic wrapper object for API responses. Success responses contain 'data', while error responses contain 'errors' array or 'error' string.
                - properties:
                    data:
                      type: object
                      properties:
                        contact_channels:
                          description: Availability of each communication channel the business has for the requested contact.
                          type: array
                          items:
                            type: object
                            description: Represents the availability of a single communication channel for a specific contact. It combines the business-level capability of the channel with a contact-level eligibility check, so callers can decide how to reach a contact in one lookup. This is a computed, read-only resource (evaluated on request) and therefore has no uid, business_uid, or timestamps.
                            properties:
                              channel_uid:
                                type: string
                                description: Unique identifier of the channel. For the core channels this is the fixed email/sms channel UID; for third-party apps it is the business channel UID, so multiple channels of the same app can be told apart and targeted individually. Treat this as an opaque value returned by the API rather than one to hardcode.
                              channel:
                                type: string
                                description: 'Identifier of the communication channel. Core channels are "email" and "sms"; installed third-party apps use their app code name (e.g., "facebook", "whatsapp", "instagram"). The set of possible values grows as new apps are installed, so treat this as an open string rather than a fixed enum. Note: a business can have multiple channels of the same app, so this value is not unique within the response — use channel_uid to distinguish them.'
                              display_name:
                                type: string
                                nullable: true
                                description: Human-readable name of the channel as set by the business (e.g., a specific Facebook page or WhatsApp number name). Null for the core email and sms channels.
                              available:
                                type: boolean
                                description: Whether the contact can currently be reached on this channel. True only when both the business supports the channel and the contact is individually eligible.
                              reason:
                                type: string
                                nullable: true
                                description: 'Machine-readable reason the channel is unavailable. Null when the channel is available. Possible values: "no_email" (contact has no email address), "email_blocked" (email is bounced/blocked and cannot receive), "no_phone" (contact has no mobile phone number), "opted_out" (contact opted out of transactional SMS), "no_active_session" (third-party channel has no active session for the contact), "app_not_installed" (business does not have the channel enabled/installed), "no_sms_credits" (business has no SMS credits left in its quota).'
                                enum:
                                - no_email
                                - email_blocked
                                - no_phone
                                - opted_out
                                - no_active_session
                                - app_not_installed
                                - no_sms_credits
                              channel_path:
                                type: string
                                nullable: true
                                description: 'The contact''s destination on this channel: the email address for email, the mobile phone for sms as it is displayed to the business (it includes the country code when the business allows clients from other countries), and the contact''s identifier on the app for third-party channels (e.g. a WhatsApp number or a page-scoped Facebook ID, which is usable for sending but not meant for display). Returned even when the channel is unavailable, so the phone of a contact who opted out of SMS can still be used for calling. Null only when the contact has no destination on the channel (e.g., "dana@example.com", "+972 050-123-4567").'
                              primary:
                                type: boolean
                                description: 'Whether this is the contact''s primary channel: the available channel the contact most recently wrote on (SMS or a third-party app). When none of those is available, email is primary if it is available. At most one entry in the response is primary; none is when no channel qualifies (e.g., true, false).'
                            required:
                            - channel_uid
                            - channel
                            - available
                            - channel_path
                            - primary
                            example:
                              channel_uid: kx7m2p9qw4rt8vzn
                              channel: whatsapp
                              display_name: Acme Main Line
                              available: true
                              reason: null
                              channel_path: '+15551234567'
                              primary: true
                      required:
                      - contact_channels
        '401':
          description: Unauthorized - Invalid or missing authentication token
        '403':
          description: Forbidden - Insufficient permissions
        '404':
          description: Not Found - The contact does not exist, does not belong to the authenticated business, or is not visible to a staff restricted to their own clients
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                errors:
                - code: missing
                  message: 'Contact not found: [peu8ljecwqr5ok58].'
        '422':
          description: Unprocessable Entity - Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                errors:
                - field: contact_uid
                  code: invalid
                  message: contact_uid is required.
      tags:
      - Contact Channels
      security:
      - Bearer: []
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
        errors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
                description: The field that caused the error (for validation errors)
              code:
                type: string
              message:
                type: string
            required:
            - code
            - message
      required:
      - success
      - errors
      example:
        success: false
        errors:
        - field: contact_uid
          code: invalid
          message: contact_uid is required.
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {app_token}'''
    Conversations:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Provide a valid staff bearer token in the Authorization header. Example: ''Authorization: Bearer {staff_token}''.'
x-provenance:
  method: searched
  source: https://developers.intandem.tech:443/reference
  harvested: '2026-11-15'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developers.intandem.tech/reference/availablephonenumberscontroller_findall.md
  - https://developers.intandem.tech/reference/businessphonenumberscontroller_create.md
  - https://developers.intandem.tech/reference/businessphonenumberscontroller_findall.md
  - https://developers.intandem.tech/reference/businessphonenumberscontroller_findone.md
  - https://developers.intandem.tech/reference/businessphonenumberscontroller_update.md
  - https://developers.intandem.tech/reference/channelscontroller_create.md
  - https://developers.intandem.tech/reference/channelscontroller_deletechannel.md
  - https://developers.intandem.tech/reference/channelscontroller_updatechannel.md
  - https://developers.intandem.tech/reference/contactchannelscontroller_index.md
  - https://developers.intandem.tech/reference/delete_platform-v1-numbers-twilio-sub-account-id.md
  - https://developers.intandem.tech/reference/delete_v3-communication-notification-templates-uid.md
  - https://developers.intandem.tech/reference/get_platform-v1-clients-client-id-conversations-1.md
  - https://developers.intandem.tech/reference/get_platform-v1-conversations.md
  - https://developers.intandem.tech/reference/get_v2-conversations-conversation-id-messages.md
  - https://developers.intandem.tech/reference/get_v3-communication-notification-templates-uid.md
  - https://developers.intandem.tech/reference/get_v3-communication-notification-templates.md
  - https://developers.intandem.tech/reference/get_v3-communication-staff-notifications-uid.md
  - https://developers.intandem.tech/reference/getstaffnotificationstats.md
  - https://developers.intandem.tech/reference/listactivitymessages.md
  - https://developers.intandem.tech/reference/liststaffnotifications.md
  - https://developers.intandem.tech/reference/messagescontroller_createmessage.md
  - https://developers.intandem.tech/reference/messagescontroller_updatestatus.md
  - https://developers.intandem.tech/reference/post_business-messaging-v1-channels-typing.md
  - https://developers.intandem.tech/reference/post_business-messaging-v1-channels.md
  - https://developers.intandem.tech/reference/post_platform-v1-messages.md
  - https://developers.intandem.tech/reference/post_platform-v1-numbers-dedicated-numbers-assign.md
  - https://developers.intandem.tech/reference/post_platform-v1-numbers-twilio.md
  - https://developers.intandem.tech/reference/post_v3-communication-notification-templates.md
  - https://developers.intandem.tech/reference/post_v3-communication-staff-notifications.md
  - https://developers.intandem.tech/reference/put_platform-v1-numbers-dedicated-numbers-set-two-way-texting-status.md
  - https://developers.intandem.tech/reference/put_v2-conversations-id.md
  - https://developers.intandem.tech/reference/put_v3-communication-notification-templates-uid.md
  - https://developers.intandem.tech/reference/quotascontroller_getquota.md
  - https://developers.intandem.tech/reference/recordingscontroller_deletevoicecallrecording.md
  - https://developers.intandem.tech/reference/recordingscontroller_updatevoicecallrecording.md
  - https://developers.intandem.tech/reference/reportscontroller_getvoicecallstats.md
  - https://developers.intandem.tech/reference/sendactivitymessage.md
  - https://developers.intandem.tech/reference/sessionscontroller_createsession.md
  - https://developers.intandem.tech/reference/sessionscontroller_getsession.md
  - https://developers.intandem.tech/reference/sessionscontroller_logicdelete.md
  - https://developers.intandem.tech/reference/sessionscontroller_updatestatus.md
  - https://developers.intandem.tech/reference/sessionstypingcontroller_typingstatus.md
  - https://developers.intandem.tech/reference/settingscontroller_create.md
  - https://developers.intandem.tech/reference/settingscontroller_delete.md
  - https://developers.intandem.tech/reference/settingscontroller_get.md
  - https://developers.intandem.tech/reference/settingscontroller_update.md
  - https://developers.intandem.tech/reference/transcriptcontroller_gettranscript.md
  - https://developers.intandem.tech/reference/voicecallscontroller_create.md
  - https://developers.intandem.tech/reference/voicecallscontroller_get.md
  - https://developers.intandem.tech/reference/voicecallscontroller_getall.md
  - https://developers.intandem.tech/reference/voicecallscontroller_update.md
  - https://developers.intandem.tech:443/reference/availablephonenumberscontroller_findall.md
  - https://developers.intandem.tech:443/reference/businessphonenumberscontroller_create.md
  - https://developers.intandem.tech:443/reference/businessphonenumberscontroller_findall.md
  - https://developers.intandem.tech:443/reference/businessphonenumberscontroller_findone.md
  - https://developers.intandem.tech:443/reference/businessphonenumberscontroller_update.md
  - https://developers.intandem.tech:443/reference/channelscontroller_create.md
  - https://developers.intandem.tech:443/reference/channelscontroller_deletechannel.md
  - https://developers.intandem.tech:443/reference/channelscontroller_updatechannel.md
  - https://developers.intandem.tech:443/reference/contactchannelscontroller_index.md
  - https://developers.intandem.tech:443/reference/delete_platform-v1-numbers-twilio-sub-account-id.md
  - https://developers.intandem.tech:443/reference/delete_v3-communication-notification-templates-uid.md
  - https://developers.intandem.tech:443/reference/get_platform-v1-clients-client-id-conversations-1.md
  - https://developers.intandem.tech:443/reference/get_platform-v1-conversations.md
  - https://developers.intandem.tech:443/reference/get_v2-conversations-conversation-id-messages.md
  - https://developers.intandem.tech:443/reference/get_v3-communication-notification-templates-uid.md
  - https://developers.intandem.tech:443/reference/get_v3-communication-notification-templates.md
  - https://developers.intandem.tech:443/reference/get_v3-communication-staff-notifications-uid.md
  - https://developers.intandem.tech:443/reference/getstaffnotificationstats.md
  - https://developers.intandem.tech:443/reference/listactivitymessages.md
  - https://developers.intandem.tech:443/reference/liststaffnotifications.md
  - https://developers.intandem.tech:443/reference/messagescontroller_createmessage.md
  - https://developers.intandem.tech:443/reference/messagescontroller_updatestatus.md
  - https://developers.intandem.tech:443/reference/post_business-messaging-v1-channels-typing.md
  - https://developers.intandem.tech:443/reference/post_business-messaging-v1-channels.md
  - https://developers.intandem.tech:443/reference/post_platform-v1-messages.md
  - https://developers.intandem.tech:443/reference/post_platform-v1-numbers-dedicated-numbers-assign.md
  - https://developers.intandem.tech:443/reference/post_platform-v1-numbers-twilio.md
  - https://developers.intandem.tech:443/reference/post_v3-communication-notification-templates.md
  - https://developers.intandem.tech:443/reference/post_v3-communication-staff-notifications.md
  - https://developers.intandem.tech:443/reference/put_platform-v1-numbers-dedicated-numbers-set-two-way-texting-status.md
  - https://developers.intandem.tech:443/reference/put_v2-conversations-id.md
  - https://developers.intandem.tech:443/reference/put_v3-communication-notification-templates-uid.md
  - https://developers.intandem.tech:443/reference/quotascontroller_getquota.md
  - https://developers.intandem.tech:443/reference/recordingscontroller_deletevoicecallrecording.md
  - https://developers.intandem.tech:443/reference/recordingscontroller_updatevoicecallrecording.md
  - https://developers.intandem.tech:443/reference/reportscontroller_getvoicecallstats.md
  - https://developers.intandem.tech:443/reference/sendactivitymessage.md
  - https://developers.intandem.tech:443/reference/sessionscontroller_createsession.md
  - https://developers.intandem.tech:443/reference/sessionscontroller_getsession.md
  - https://developers.intandem.tech:443/reference/sessionscontroller_logicdelete.md
  - https://developers.intandem.tech:443/reference/sessionscontroller_updatestatus.md
  - https://developers.intandem.tech:443/reference/sessionstypingcontroller_typingstatus.md
  - https://developers.intandem.tech:443/reference/settingscontroller_create.md
  - https://developers.intandem.tech:443/reference/settingscontroller_delete.md
  - https://developers.intandem.tech:443/reference/settingscontroller_get.md
  - https://developers.intandem.tech:443/reference/settingscontroller_update.md
  - https://developers.intandem.tech:443/reference/transcriptcontroller_gettranscript.md
  - https://developers.intandem.tech:443/reference/voicecallscontroller_create.md
  - https://developers.intandem.tech:443/reference/voicecallscontroller_get.md
  - https://developers.intandem.tech:443/reference/voicecallscontroller_getall.md
  - https://developers.intandem.tech:443/reference/voicecallscontroller_update.md
  merge:
    pages: 102
    deduped: 294
    conflicts_kept_first: 0