Ringover Tags API

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 Tags 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: Tags
  description: 'Manage call tags. Tags are labels you can assign to calls for categorization and reporting. Each tag has an ID, name, color, description, and creation date.


    **Permissions required:**

    - **Read** (`IVRs R`): List tags.

    - **Write** (`IVRs W`): Create new tags.


    **Monitoring impact:** None — tags are always team-wide.'
paths:
  /tags:
    get:
      operationId: getTags
      tags:
      - Tags
      x-permissions:
        required: IVRs R
        monitoring: none
      summary: List all call tags
      description: 'Retrieves all tags defined for your team. Tags are labels that can be attached to calls for categorization and reporting purposes (e.g., "support", "sales", "follow-up"). Tags are team-wide — all users share the same tag set. The total count is in the `list_count` field.


        **Permission:** `IVRs Read` required.


        **Monitoring:** Not needed. All team tags are returned regardless of the Monitoring flag.'
      responses:
        '200':
          description: Successful operation — returns the list of tags.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tag_list'
        '204':
          description: No tags found.
        '401':
          description: Unauthorized — invalid or missing API token, or missing `IVRs Read` permission.
        '500':
          description: Internal server error.
    post:
      operationId: postTags
      tags:
      - Tags
      x-permissions:
        required: IVRs W
        monitoring: none
      summary: Create a new call tag
      description: 'Creates a new tag for your team. Tags are team-wide labels used to categorize calls. Each tag has a `name`, an optional `description`, and a `color` chosen from a predefined palette (18 hex colors). Tag names should be unique within the team. Once created, tags can be attached to calls for filtering and reporting.


        **Permission:** `IVRs Write` required.


        **Monitoring:** Not needed. Tag creation works regardless of the Monitoring flag.'
      requestBody:
        description: a tag
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The name of the tag
                  example: mytag
                color:
                  type: string
                  enum:
                  - ff6b6b
                  - F06292
                  - BA68C8
                  - 9575CD
                  - 7986CB
                  - 64B5F6
                  - 4FC3F7
                  - 4DD0E1
                  - 4DB6AC
                  - 81C784
                  - AED581
                  - DCE775
                  - FFD54F
                  - FFB74D
                  - FF8A65
                  - A1887F
                  - E0E0E0
                  - 90A4AE
                  example: ff6b6b
                description:
                  type: string
                  description: The description of the tag
                  example: my tag description
        required: true
      responses:
        '200':
          description: Successful operation — tag created.
        '401':
          description: Unauthorized — invalid or missing API token, or missing `IVRs Write` permission.
        '500':
          description: Internal server error.
  /tags/{tagId}:
    get:
      operationId: getTagsTagid
      tags:
      - Tags
      x-permissions:
        required: IVRs R
        monitoring: none
      summary: Get a tag by ID
      description: 'Retrieves detailed information about a specific call tag by its identifier, including its name, color, description, and creation metadata. Use `GET /tags` to discover available tag IDs.


        **Permission:** `IVRs Read` required.


        **Monitoring:** Not needed. Tag details are returned regardless of the Monitoring flag.'
      parameters:
      - name: tagId
        in: path
        description: The identifier of the tag
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful operation — returns the tag details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tag'
        '400':
          description: Invalid tag identifier.
        '401':
          description: Unauthorized — invalid or missing API token, or missing `IVRs Read` permission.
        '404':
          description: Tag not found.
        '500':
          description: Internal server error.
components:
  schemas:
    tag:
      type: object
      properties:
        tag_id:
          type: integer
          format: int64
          description: The identifier of the tag
          example: 123
        name:
          type: string
          description: The name of the tag
          example: mytag
        color:
          type: string
          enum:
          - ff6b6b
          - F06292
          - BA68C8
          - 9575CD
          - 7986CB
          - 64B5F6
          - 4FC3F7
          - 4DD0E1
          - 4DB6AC
          - 81C784
          - AED581
          - DCE775
          - FFD54F
          - FFB74D
          - FF8A65
          - A1887F
          - E0E0E0
          - 90A4AE
          example: ff6b6b
        description:
          type: string
          description: The description of the tag
          example: my tag description
        creation_date:
          type: string
          format: date-time
          example: '2018-08-12T12:12:40.53Z'
    tag_list:
      type: object
      properties:
        list_count:
          type: integer
          format: int64
          description: The size of the list
          example: 1
        list:
          type: array
          items:
            $ref: '#/components/schemas/tag'
  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