Sonar Users API
The Users API from Sonar — 2 operation(s) for users.
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-users-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 Users API
version: '1.0'
servers:
- url: https://www.sendsonar.com/api
security:
- sec0: []
sec1: []
tags:
- name: Users
paths:
/v1/users:
get:
summary: GET All Users from Account
description: An API to list all users in your Sonar Account
operationId: get-all-users-from-account
parameters:
- name: X-Token
in: header
description: Token for a given account found in the 'Company Settings' of your Sonar Account
required: true
schema:
type: string
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "[\n {\n \"id\": \"5cd84cea-XXXX-4407-8d6b-05f9f3860417\",\n \"created_at\": \"2021-05-17T15:24:44.569-07:00\",\n \"email\": \"tstark@sendsonar.com\",\n \"company_publishable_key\": \"0908XXXX-fe9c-XXXXX-a803-c35adXXXXee4\",\n \"first_name\": \"Tony\",\n \"last_name\": \"Stark\",\n \"active\": true,\n \"role_id\": \"5b2273ec-XXXX-4b79-XXXX-36e4120cf5a6\",\n \"invite_accepted\": true\n },\n {\n \"id\": \"XXXX21d7-a764-438e-XXXX-eeffe527f42b\",\n \"created_at\": \"2021-07-09T06:44:34.631-07:00\",\n \"email\": \"srodgers@sendsonar.com\",\n \"company_publishable_key\": \"0908XXXX-fe9c-XXXXX-a803-c35adXXXXee4\",\n \"first_name\": \"Steve\",\n \"last_name\": \"Rodgers\",\n \"active\": true,\n \"role_id\": null,\n \"invite_accepted\": false\n }\n]"
schema:
type: array
items:
type: object
properties:
id:
type: string
example: 5cd84cea-XXXX-4407-8d6b-05f9f3860417
created_at:
type: string
example: '2021-05-17T15:24:44.569-07:00'
email:
type: string
example: tstark@sendsonar.com
company_publishable_key:
type: string
example: 0908XXXX-fe9c-XXXXX-a803-c35adXXXXee4
first_name:
type: string
example: Tony
last_name:
type: string
example: Stark
active:
type: boolean
example: true
default: true
role_id:
type: string
example: 5b2273ec-XXXX-4b79-XXXX-36e4120cf5a6
invite_accepted:
type: boolean
example: true
default: true
'401':
description: '401'
content:
application/json:
examples:
Result:
value: "{\n \"error\": \"Token or publishable_key not found\"\n}"
schema:
type: object
properties:
error:
type: string
example: Token or publishable_key not found
deprecated: false
x-readme:
code-samples:
- language: curl
code: 'curl ''https://www.sendsonar.com/api/v1/users'' \
-X GET \
-H ''X-Token:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'''
samples-languages:
- curl
tags:
- Users
post:
summary: Invite new User
description: ''
operationId: invite-new-user
parameters:
- name: X-Token
in: header
description: Sonar Company token
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
required:
- email
properties:
email:
type: string
description: Email address of the user you want to invite into your account
role_id:
type: string
description: Role UUID for a given customer role you created in your account. Default value if not provided will be a member role in the Sonar Account.
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"id\": \"49ca435b-XXXX-4266-XXXX-48f7c4afeXXX\",\n \"created_at\": \"2021-09-30T14:13:59.399-07:00\",\n \"email\": \"userName@domain.com\",\n \"company_publishable_key\": \"09081510-fe9c-45fb-a803-c35ad28fbee4\",\n \"first_name\": null,\n \"last_name\": null,\n \"active\": true,\n \"role_id\": \"b1cb0054-XXXX-45c1-9a20-7d476bc3c734\",\n \"invite_accepted\": false\n}"
schema:
type: object
properties:
id:
type: string
example: 49ca435b-XXXX-4266-XXXX-48f7c4afeXXX
created_at:
type: string
example: '2021-09-30T14:13:59.399-07:00'
email:
type: string
example: userName@domain.com
company_publishable_key:
type: string
example: 09081510-fe9c-45fb-a803-c35ad28fbee4
first_name: {}
last_name: {}
active:
type: boolean
example: true
default: true
role_id:
type: string
example: b1cb0054-XXXX-45c1-9a20-7d476bc3c734
invite_accepted:
type: boolean
example: false
default: true
'400':
description: '400'
content:
application/json:
examples:
Incorrect Role Id:
value: "{\n \"error\": \"Role not found\"\n}"
Invalid email address:
value: "{\n \"error\": \"email is invalid\"\n}"
schema:
oneOf:
- title: Incorrect Role Id
type: object
properties:
error:
type: string
example: Role not found
- title: Invalid email address
type: object
properties:
error:
type: string
example: email is invalid
'401':
description: '401'
content:
application/json:
examples:
Unauthorized:
value: "{\n \"error\": \"Token or publishable_key not found\"\n}"
schema:
type: object
properties:
error:
type: string
example: Token or publishable_key not found
deprecated: false
x-readme:
code-samples:
- language: curl
code: "curl 'https://www.sendsonar.com/api/v1/users' \\\n -X POST \\\n -H 'X-Token:XXXXXXXXXXXXXXXXXXXXXXXX' \\\n -H \"Content-Type: application/json\" \\\n -d '{\"email\": \"userName@domain.com\", \"role_id\": \"b1cb0054-XXXX-45c1-9a20-7d476bc3c734\"}'"
samples-languages:
- curl
tags:
- Users
/v1/users/{:id}:
get:
summary: GET User by ID
description: An API to get information about a specific user from your Sonar Account
operationId: get-specific-user-by-id
parameters:
- name: X-Token
in: header
description: Token for a given account found in the 'Company Settings' of your Sonar Account
required: true
schema:
type: string
- name: id
in: path
description: The unique ID of the user you want to retrieve
schema:
type: string
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"id\": \"5cd84cea-XXXX-4407-8d6b-XXXXf386ZZZZ\",\n \"created_at\": \"2021-05-17T15:24:44.569-07:00\",\n \"email\": \"tstark@sendsonar.com\",\n \"company_publishable_key\": \"0908XXXX-fe9c-XXXXX-a803-c35adXXXXee4\",\n \"first_name\": \"Tony\",\n \"last_name\": \"Stark\",\n \"active\": true,\n \"role_id\": \"5b2273ec-XXXX-4b79-XXXX-36e4120cf5a6\",\n \"invite_accepted\": true\n}"
schema:
type: object
properties:
id:
type: string
example: 5cd84cea-XXXX-4407-8d6b-XXXXf386ZZZZ
created_at:
type: string
example: '2021-05-17T15:24:44.569-07:00'
email:
type: string
example: tstark@sendsonar.com
company_publishable_key:
type: string
example: 0908XXXX-fe9c-XXXXX-a803-c35adXXXXee4
first_name:
type: string
example: Tony
last_name:
type: string
example: Stark
active:
type: boolean
example: true
default: true
role_id:
type: string
example: 5b2273ec-XXXX-4b79-XXXX-36e4120cf5a6
invite_accepted:
type: boolean
example: true
default: true
'401':
description: '401'
content:
application/json:
examples:
Result:
value: "{\n \"error\": \"Token or publishable_key not found\"\n}"
schema:
type: object
properties:
error:
type: string
example: Token or publishable_key not found
deprecated: false
x-readme:
code-samples:
- language: curl
code: "curl 'https://www.sendsonar.com/api/v1/users/id' \\\n\t-X GET \\\n -H 'X-Token:XXXXXXXXXXXXXXXXXXXXXXXX'"
samples-languages:
- curl
tags:
- Users
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