Sonar Conversations API
The Conversations API from Sonar — 1 operation(s) for conversations.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/sendsonar-com:sendsonar-com-conversations-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Settings Conversations API
version: '1.0'
servers:
- url: https://www.sendsonar.com/api
security:
- sec0: []
sec1: []
tags:
- name: Conversations
paths:
/v1/conversations/{id}:
get:
summary: GET Conversation by ID
description: A Conversation is a group of messages exchanged between your Sonar account and a Customer. Using this API you can retrieve the messages in a conversation and information about the customer with which the messages were exchanged. You can obtain conversation IDs from webhooks; including new unassigned message, new assigned message, tag added to message, and customer state change.
operationId: get-conversation-by-id
parameters:
- name: X-Token
in: header
description: Your Sonar Account's Private Token
required: true
schema:
type: string
- name: id
in: path
description: The ID of a conversation. Conversation_id can be obtained from webhooks such as new_assigned_message
schema:
type: string
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"status\": \"success\",\n \"conversation\": {\n \"id\": \"XXXc8f6c-91cd-40fc-XXXX-9ce608c854d1\",\n \"created_at\": \"2023-04-17T17:51:55.281948Z\",\n \"closed_at\": null\n },\n \"customer\": {\n \"customer_id\": \"XXX1e463-2bc7-XXXX-bc7b-a68c54d1fXXX\",\n \"first_name\": \"Customer\",\n \"last_name\": \"Name\",\n \"phone_number\": \"+12062505555\",\n \"fb_id\": null,\n \"external_id\": null,\n \"email\": \"Customer-Name@yahoo.com\",\n \"current_state\": \"claimed\",\n \"subscribed\": true,\n \"doubly_opted_in\": true,\n \"unsubscribed_at\": null,\n \"link\": \"https://dashboard.sendsonar.com/thread/kjqfhfk\",\n \"created_at\": \"2022-12-30T18:20:17Z\",\n \"company_publishable_key\": \"XXX8cb66-7a62-XXXX-bd4f-45013b668XXX\",\n \"team_names\": [\n \"Sales Team\"\n ],\n \"public_id\": \"XXX1e463-2bc7-XXXX-bc7b-a68c54d1fXXX\"\n },\n \"messages\": [\n {\n \"to_phone_number\": \"+12062505555\",\n \"from_phone_number\": \"+18446205555\",\n \"media_url\": null,\n \"text\": \"Hi Customer, you requested a quote on our website. Can I give you a call to ask a few questions?\",\n \"public_id\": \"XXXf32b9-f49d-4cdf-XXXX-d1573ee4XXXX\",\n \"created_at\": \"2023-04-17T17:51:53.059046Z\",\n \"away_message\": false,\n \"user\": {\n \"first_name\": \"Bill\",\n \"last_name\": \"Smith\",\n \"email\": \"bill.smith@sendsonar.com\"\n },\n \"campaign\": {\n \"slug\": \"r6j5xX\",\n \"name\": \"Webform follow up\"\n }\n },\n {\n \"to_phone_number\": \"+18446205555\",\n \"from_phone_number\": \"+12062505555\",\n \"media_url\": null,\n \"text\": \"Sure. When?\",\n \"public_id\": \"XXXd115c-4bad-XXXX-9391-2528a186XXXX\",\n \"created_at\": \"2023-04-17T17:52:04.384661Z\",\n \"away_message\": false,\n \"user\": {\n \"first_name\": \"Bill\",\n \"last_name\": \"Smith\",\n \"email\": \"bill.smith@sendsonar.com\"\n },\n \"tags\": [\n \"collected-budget\"\n ]\n },\n {\n \"to_phone_number\": \"+12062505555\",\n \"from_phone_number\": \"+18446205555\",\n \"media_url\": null,\n \"text\": \"I can call now. Or if that doesn't work, what time works for you?\",\n \"public_id\": \"XXX8d0c8-42e8-4c13-XXXX-5bdfe819XXXX\",\n \"created_at\": \"2023-04-17T17:53:01.204258Z\",\n \"away_message\": false,\n \"user\": {\n \"first_name\": \"Bill\",\n \"last_name\": \"Smith\",\n \"email\": \"bill.smith@sendsonar.com\"\n }\n }\n ]\n}"
schema:
type: object
properties:
status:
type: string
example: success
conversation:
type: object
properties:
id:
type: string
example: XXXc8f6c-91cd-40fc-XXXX-9ce608c854d1
created_at:
type: string
example: '2023-04-17T17:51:55.281948Z'
closed_at: {}
customer:
type: object
properties:
customer_id:
type: string
example: XXX1e463-2bc7-XXXX-bc7b-a68c54d1fXXX
first_name:
type: string
example: Customer
last_name:
type: string
example: Name
phone_number:
type: string
example: '+12062505555'
fb_id: {}
external_id: {}
email:
type: string
example: Customer-Name@yahoo.com
current_state:
type: string
example: claimed
subscribed:
type: boolean
example: true
default: true
doubly_opted_in:
type: boolean
example: true
default: true
unsubscribed_at: {}
link:
type: string
example: https://dashboard.sendsonar.com/thread/kjqfhfk
created_at:
type: string
example: '2022-12-30T18:20:17Z'
company_publishable_key:
type: string
example: XXX8cb66-7a62-XXXX-bd4f-45013b668XXX
team_names:
type: array
items:
type: string
example: Sales Team
public_id:
type: string
example: XXX1e463-2bc7-XXXX-bc7b-a68c54d1fXXX
messages:
type: array
items:
type: object
properties:
to_phone_number:
type: string
example: '+12062505555'
from_phone_number:
type: string
example: '+18446205555'
media_url: {}
text:
type: string
example: Hi Customer, you requested a quote on our website. Can I give you a call to ask a few questions?
public_id:
type: string
example: XXXf32b9-f49d-4cdf-XXXX-d1573ee4XXXX
created_at:
type: string
example: '2023-04-17T17:51:53.059046Z'
away_message:
type: boolean
example: false
default: true
user:
type: object
properties:
first_name:
type: string
example: Bill
last_name:
type: string
example: Smith
email:
type: string
example: bill.smith@sendsonar.com
campaign:
type: object
properties:
slug:
type: string
example: r6j5xX
name:
type: string
example: Webform follow up
'400':
description: '400'
content:
application/json:
examples:
Result:
value: "{\n \"error\": \"cannot find conversation without id\"\n}"
schema:
type: object
properties:
error:
type: string
example: cannot find conversation without id
'404':
description: '404'
content:
application/json:
examples:
Result:
value: "{\n \"error\": \"Can not find conversation\"\n}"
schema:
type: object
properties:
error:
type: string
example: Can not find conversation
deprecated: false
tags:
- Conversations
components:
securitySchemes:
sec0:
type: apiKey
name: X-Token
in: header
x-default: ''
sec1:
type: apiKey
name: token
in: query
x-default: ''
x-readme-fauxas: true
x-provenance:
method: searched
source: https://docs.sendsonar.com/reference
harvested: '2026-10-25'
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://docs.sendsonar.com/reference/addupdate-customer.md
- https://docs.sendsonar.com/reference/append-tag-to-message.md
- https://docs.sendsonar.com/reference/available-phone-number.md
- https://docs.sendsonar.com/reference/close-customer.md
- https://docs.sendsonar.com/reference/create-new-role-permission.md
- https://docs.sendsonar.com/reference/create-new-sonar-account.md
- https://docs.sendsonar.com/reference/create-webhook.md
- https://docs.sendsonar.com/reference/delete-customer-properties.md
- https://docs.sendsonar.com/reference/delete-webhooks.md
- https://docs.sendsonar.com/reference/double-opt-in-prompt.md
- https://docs.sendsonar.com/reference/events.md
- https://docs.sendsonar.com/reference/follow-up-endpoint.md
- https://docs.sendsonar.com/reference/gdpr-delete-request.md
- https://docs.sendsonar.com/reference/gdpr-get-request.md
- https://docs.sendsonar.com/reference/get-account-roles.md
- https://docs.sendsonar.com/reference/get-all-users-from-account.md
- https://docs.sendsonar.com/reference/get-conversation-by-id.md
- https://docs.sendsonar.com/reference/get-customer.md
- https://docs.sendsonar.com/reference/get-specific-user-by-id.md
- https://docs.sendsonar.com/reference/get-webhook.md
- https://docs.sendsonar.com/reference/invite-new-user.md
- https://docs.sendsonar.com/reference/personalized-campaign.md
- https://docs.sendsonar.com/reference/remove-follow-up.md
- https://docs.sendsonar.com/reference/send-campaign.md
- https://docs.sendsonar.com/reference/send-message.md
- https://docs.sendsonar.com/reference/unassign-agent.md
- https://docs.sendsonar.com/reference/update-webhook.md
merge:
pages: 27
deduped: 52
conflicts_kept_first: 0