Ringover Users API

Manage your Ringover team members. Retrieve user information, manage plannings, check availability (presences/snooze), and organize user blacklists. **Permissions required:** - **Read** (`Users R`): Get user details, plannings, presences, user blacklists. - **Write** (`Users W`): Modify plannings, manage group members, manage user blacklists, modify snooze status. **Monitoring impact:** - *OFF*: GET requests return **only your own** user data, planning, and presence. Group listing returns only groups you belong to. - *ON*: GET requests return **all team** users, plannings, and presences. You can modify **any user's** planning. > Some write operations (plannings, group membership) **require** Monitoring ON and will return `401` without it.

GitHub OpenAPI

Operations 12

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 Evangelist overlay

GET /users List all team users · List all team users #
Ask an LLM
“Who are the users on my team?”
“Can I see every user's phone number and status?”
Tell an agent
List all users on my team.
Show every team member with their assigned numbers and status.
POST /users Create a user by email and number (deprecated) · Create a user (deprecated — use /users/invite) #
Ask an LLM
“How do I add a new user to the team from their email and phone number?”
“Is there an older endpoint for creating users from an email address?”
Tell an agent
Create a user with email {email} and phone number {number}.
Add {email} as a new user on {number} using the deprecated create endpoint.
GET /users/{userId} Get a user's profile and numbers · Get a user by ID #
Ask an LLM
“What phone numbers and status does a specific user have?”
“Can I look up one user's profile by ID?”
Tell an agent
Get user {userId}.
Show the profile, numbers and status of user {userId}.
DELETE /users/{userId} Delete or archive a user · Delete or archive a user #
Ask an LLM
“How do I permanently delete a user's account?”
“Can I archive a user instead of deleting them?”
Tell an agent destructive · confirm first
Delete user {userId}.
Archive user {userId} with type {type}.
POST /users/{userId}/profiles/{profileId} Assign a profile to a user · Assign a profile to a user #
Ask an LLM
“How do I change a user's telephony profile?”
“Does reassigning a profile change how a user handles calls?”
Tell an agent
Assign profile {profileId} to user {userId}.
Replace the profile of user {userId} with {profileId}.
GET /users/{userId}/plannings Get a user's weekly availability planning · Get a user's weekly planning #
Ask an LLM
“When is a user available each day of the week?”
“Can I see a user's weekly planning with start and end times?”
Tell an agent
Get the weekly planning for user {userId}.
Show when user {userId} is available each day.
PUT /users/{userId}/plannings Replace a user's full weekly planning · Replace a user's entire weekly planning #
Ask an LLM
“How do I set a user's availability for the whole week at once?”
“What happens if I replace a user's planning with an empty week?”
Tell an agent
Replace the entire weekly planning of user {userId}.
Set a full week of availability for user {userId}.
PUT /users/{userId}/plannings/{day} Replace a user's planning for one day · Replace a user's planning for a specific day #
Ask an LLM
“Can I change a user's availability for just one day?”
“How do I set a user's planning for a single day of the week?”
Tell an agent
Replace the planning for {day} for user {userId}.
Set user {userId}'s availability on {day}.
GET /users/{userId}/presences Get a user's presence status · Get a user's presence status #
Ask an LLM
“Is a user available, on a call or in snooze right now?”
“Which device is a user connected from?”
Tell an agent
Get the presence status of user {userId}.
Show whether user {userId} is available, on a call or in snooze.
GET /users/{userId}/snooze/log Get a user's snooze history · Get a user's snooze history #
Ask an LLM
“When has a user been snoozed and for how long?”
“Can I see a user's snooze history?”
Tell an agent
Get the snooze history for user {userId}.
Show the last {limit_count} snooze events for user {userId}.
PUT /users/{userId}/snooze Snooze a user for a time · Set or clear a user's snooze status #
Ask an LLM
“How do I mark a user as unavailable for a while?”
“Can I set a snooze that expires automatically?”
Tell an agent
Snooze user {userId} as {name}.
Snooze user {userId} as {name} for {duration} seconds.
POST /users/invite Invite users to the team · Invite multiple users to the team #
Ask an LLM
“How do I invite new users to the team by email?”
“Does inviting users consume licences?”
Tell an agent
Invite these users to the team: {users}.
Invite {users} to the team, with me as the inviter {invited_by}.

Specifications

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/ringover:ringover-users-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

ringover-users-api-openapi.yml Raw ↑
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 Users 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:


# --- truncated at 32 KB (39 KB total) ---
# Full source: https://artifacts.apis.io/ringover/openapi/ringover-users-api-openapi.yml