Manage team tasks. Create, list, and manage tasks associated with your team. **Permissions:** No specific permission required. A valid API key is sufficient.
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelistoverlay
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.
openapi: 3.2.0
info:
license:
name: Proprietary – Contact us for usage terms
url: https://www.ringover.com/contact
description: '# Ringover Public API
Welcome to the Ringover Public API. This RESTful API lets you integrate Ringover telephony, messaging, contacts, and AI analytics into your applications. ## Base URL
| Region | Base URL |
|--------|----------|
| Europe | `https://public-api.ringover.com/v2` |
| United States | `https://public-api-us.ringover.com/v2` |
## Authentication
All requests must include your API key in the `Authorization` header:
```
Authorization: your-api-key-here
```
To create an API key:
1. Open the Ringover Dashboard. 2. Navigate to **Developer > API Keys**. 3. Click **Create an API key**, select a user, and set a label. 4. Configure the permissions for this key (see Permissions below). ## Permissions
Each API key is associated with **7 permission categories**, each configurable as **None**, **Read**, **Write**, or **Read+Write**:
| Category | Controls access to |
|----------|-------------------|
| **Calls** | Call history, archives, live call controls, callbacks |
| **Contacts** | Contact CRUD and phone number management |
| **Users** | User listing, plannings, presences, groups, user blacklists |
| **Numbers** | Phone number listing, team blacklist |
| **IVRs** | IVR/scenario listing, tag management |
| **Conversations** | SMS/Chat conversations, messages, SMS sending |
| **Empower** | AI call analysis, summaries, moments, analytics |
### The Monitoring flag (Supervision)
In addition to R/W permissions, each API key has a **Monitoring** toggle that controls the **scope** of data returned:
| Monitoring | Effect |
|------------|--------|
| **OFF** | Your permissions give access to **your own data only** (your calls, your numbers, your conversations…) |
| **ON** | Your permissions give access to **the entire team''s data** (all users, all calls, all conversations…) |
Monitoring does **not** grant additional permissions — it widens the scope of existing ones. Some routes **require** Monitoring to be enabled and will return `401` without it. Conversely, some routes may ignore the Monitoring flag entirely or apply it differently — unless stated otherwise in the endpoint documentation, the default behavior described above applies. > Each endpoint in this documentation specifies its exact permission and monitoring requirements. ### Special cases
- **Campaigns, Tasks, WhatsApp**: These routes do not require specific token permissions. A valid API key is sufficient. - **Empower**: Uses its own role system (Admin / Supervisor / User) in addition to the Empower R/W permission. - **Transcriptions**: Access is controlled by a team-level setting, not by the token permissions. - **Conferences**: All conference routes require Monitoring enabled. ## Rate Limiting
A **2-request-per-second** rate limit is applied per API key. Exceeding this limit returns `429 Too Many Requests`. ## Pagination
List endpoints support offset-based pagination with two parameters:
- `limit_count`: Maximum number of items to return (default: 100, max varies by endpoint). - `limit_offset`: Number of items to skip (default: 0). Some call-related endpoints also support cursor-based pagination via `last_id_returned`. ## Error Responses
| HTTP Code | Meaning |
|-----------|---------|
| `400` | Bad request — invalid parameters or body |
| `401` | Unauthorized — invalid/expired API key, or access denied by permission/monitoring checks on most endpoints |
| `403` | Forbidden — authenticated request refused by specific endpoint logic (notably some Empower routes) or upstream forwarded services |
| `402` | Payment required — feature not available on your plan |
| `404` | Resource not found |
| `429` | Rate limit exceeded |
| `500` | Internal server error |
## SCIM 2.0 Provisioning
Ringover exposes a **SCIM 2.0** server (RFC 7643 / RFC 7644) for automated user and group provisioning from your identity provider (Okta, Microsoft Entra ID, …). It reuses the **same API key** as the REST API (`Authorization` header).'
version: 2.1.0
title: Ringover Public Task API
x-logo:
url: https://webcdn.ringover.com/app/img/misc/logo_app_redoc.png
backgroundColor: '#FAFAFA'
altText: Ringover Logo
termsOfService: https://ringover.com/terms/
contact:
email: support@ringover.com
servers:
- url: https://public-api.ringover.com/v2
description: Production server (Europe)
- url: https://public-api-us.ringover.com/v2
description: Production server (United States)
security:
- Authorization: []
tags:
- name: Task
description: 'Manage team tasks. Create, list, and manage tasks associated with your team.
**Permissions:** No specific permission required. A valid API key is sufficient.'
paths:
/tasks/team:
post:
operationId: postPublicTasksTeam
tags:
- Task
x-permissions:
required: none
monitoring: none
summary: Get team tasks
description: 'Retrieves tasks for your team based on the provided filters.
**Permission:** No specific permission required. A valid API key is sufficient.
**Monitoring:** No impact.'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/team_task_request'
responses:
'200':
description: Successful operation — returns the list of matching tasks.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/task'
'400':
description: Bad request — invalid filter parameters.
'401':
description: Unauthorized — missing or invalid token.
'403':
description: Forbidden — user is not part of your team or caller is not technical.
'500':
description: Internal server error.
/tasks/team/create_batch:
post:
operationId: postPublicTasksTeamCreate_batch
tags:
- Task
x-permissions:
required: none
monitoring: none
summary: Create a batch of tasks from a list of numbers
description: 'Creates multiple tasks at once from a list of phone numbers. Returns the UUIDs of the created tasks.
**Permission:** No specific permission required. A valid API key is sufficient.
**Monitoring:** No impact.'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/create_task_batch'
responses:
'200':
description: Successful operation — returns the UUIDs of the created tasks.
content:
application/json:
schema:
type: array
items:
type: string
format: uuid
'204':
description: No content — no tasks were created (e.g. empty input list).
'400':
description: Bad request — invalid input data.
'401':
description: Unauthorized — missing or invalid token.
'403':
description: Forbidden — user is not part of your team or caller is not technical.
'500':
description: Internal server error.
components:
schemas:
create_task_batch:
type: object
required:
- type
- status
- scheduled_date
- numbers
properties:
type:
type: string
enum:
- CALL
- SMS
- MEET
example: CALL
data:
type: string
description: 'Deprecated: This field is deprecated and will be removed in a future version.'
deprecated: true
status:
type: string
enum:
- IN_PROGRESS
- PENDING
- DONE
- DELETED
example: PENDING
details:
type: string
example: Description
priority:
type: integer
format: enum
enum:
- 0
- 1
description: 1 marks the task as important
example: 0
scheduled_date:
type: string
format: date-time
example: '2025-07-05T15:00:00.000Z'
numbers:
type: array
items:
type: string
example:
- '33123456789'
call_uuid:
type: string
format: uuid
description: 'Deprecated: This field is deprecated and will be removed in a future version.'
deprecated: true
user_id:
type: integer
format: int64
example:
priority: 1
details: Description
scheduled_date: '2025-07-05T15:00:00.000Z'
status: PENDING
type: CALL
numbers:
- '33123456789'
team_task_request:
type: object
properties:
type:
type: string
status:
type: array
items:
type: string
group_ids:
type: array
items:
type: integer
user_ids:
type: array
items:
type: integer
creation_date_start:
type: string
creation_date_end:
type: string
limit_count:
type: integer
limit_offset:
type: integer
order_by:
type: string
order_direction:
type: string
task:
type: object
properties:
teamId:
type: integer
format: int32
userId:
type: integer
format: int32
type_id:
type: integer
format: int32
example: 1
data:
type: string
format: nullable
details:
type: string
format: nullable
type:
type: string
format: nullable
example: type1
priority:
type: integer
format: int32
createdBy:
type: integer
format: int32
status:
type: string
format: nullable
example: PENDING
scheduledDate:
type: string
format: date-time
example: '2018-08-12T12:12:40.53Z'
deletionDate:
type: string
format: date-time
example: '2018-08-12T12:12:40.53Z'
securitySchemes:
Authorization:
description: "We use API keys for authentication to authorize API requests. First, you need to create a public access token (API key) and select the appropriate rights for each user. To do so:\n 1. Open the Ringover Dashboard.\n 2. Go to the **Developer** section.\n 3. Click the **Create an API key** button.\n 4. Select a user in the drop-down menu and enter a label for the key and click the **Create** button.\n 5. Click the **Edit** button corresponding to the API key and select the appropriate rights.\n\nOnce you've created a public access token, you can use it in the `Authorization` header to authenticate your HTTP request.\n\n```\nAuthorization: <your-public-token>\n```\n\nThis is the **recommended authentication method** and the only one supported by the REST and SCIM endpoints.\n"
type: apiKey
name: Authorization
in: header
AuthorizationQuery:
description: '**Alternative authentication method, only available on the MCP endpoint (`/mcp`).**
Pass your Public API token via the `token` query string parameter:
```
POST /mcp?token=<your-public-token>
```
Useful for clients (no-code platforms, browser tools, etc.) that cannot set custom HTTP headers.
See the **mcp** tag for details on the three accepted authentication sources and their precedence.
'
type: apiKey
name: token
in: query
AuthorizationPath:
description: '**Alternative authentication method, only available on the MCP endpoint (`/mcp/{token}`).**
Pass your Public API token directly inside the URL path:
```
POST /mcp/<your-public-token>
```
Most permissive variant — works with any HTTP client, including those that strip custom headers and query strings.
> ⚠️ The token appears in URLs and is therefore likely to be logged by proxies, browsers and access logs. Prefer the `Authorization` header whenever your client supports it, and rotate any token that may have leaked.
OpenAPI 3.0 does not support `apiKey` in `path`, so this scheme is declared in `query` for tooling compatibility — the actual transport is the URL path. See the **mcp** tag for details.
'
type: apiKey
name: token
in: query
x-tagGroups:
- name: Ringover Public API
tags:
- How to paginate?
- teams
- groups
- users
- numbers
- ivrs
- tags
- conferences
- calls
- campaigns
- channels
- contacts
- conversations
- messages
- sms
- profiles
- presences
- blacklist
- webhook
- callbacks
- surveys
- snoozes
- transcriptions
- cdn
- empower
- whatsapp
- task
- mcp
- name: SCIM 2.0 Provisioning
tags:
- scim