Regal

Regal Users API

List and retrieve Regal user accounts — both human agents and AI agents — with their skills, teams, custom attributes and eligible routing queues. List Users supports cursor pagination and filtering by email, skills, teams, queues and customAttributes; Get User resolves a single account by Regal user UUID or exact (URL-encoded) login email. Both operations are limited to 10 requests per second.

GitHub OpenAPI
Business capability
Contact Centre Operations Management BC-430.30

Operations 2

GET /users/{userIdOrEmail} Get User #
GET /users List Users #

Documentation

📖
Documentation
https://developer.regal.ai/reference/list-users
📖
Documentation
https://developer.regal.ai/reference/get-user
📖
Documentation
https://developer.regal.ai/reference/overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/regal-ai/refs/heads/main/openapi/regal-ai-users-api-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/regal-ai/refs/heads/main/overlays/regal-ai-users-overlay.yaml
🔗
AgentSkill
https://raw.githubusercontent.com/api-evangelist/regal-ai/refs/heads/main/skills/regal-ai-resolve-call-handoff.md

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/regal-ai-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

regal-ai-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: contact-center-apis Users API
  version: '1.2'
servers:
- url: https://api.regal.ai/v1
security:
- sec0: []
tags:
- name: Users
paths:
  /users/{userIdOrEmail}:
    get:
      responses:
        '200':
          description: User returned successfully.
          content:
            application/json:
              examples:
                OK:
                  summary: OK
                  value:
                    id: 11111111-1111-4111-8111-111111111101
                    email: user@example.com
                    firstName: Avery
                    lastName: User
                    skills:
                    - name: Outbound Call
                    teams:
                    - id: 22222222-2222-4222-8222-222222222202
                      name: Sales Team
                    customAttributes:
                      tier: gold
                    eligibleQueues:
                    - id: 33333333-3333-4333-8333-333333333303
                      name: Sales Queue
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: 11111111-1111-4111-8111-111111111101
                  email:
                    type: string
                    example: user@example.com
                  firstName:
                    type: string
                    example: Avery
                  lastName:
                    type: string
                    example: User
                  skills:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          example: Outbound Call
                        disabled:
                          type: boolean
                  teams:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 22222222-2222-4222-8222-222222222202
                        name:
                          type: string
                          example: Sales Team
                  customAttributes:
                    type: object
                    properties:
                      tier:
                        type: string
                        example: gold
                  eligibleQueues:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 33333333-3333-4333-8333-333333333303
                        name:
                          type: string
                          example: Sales Queue
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    default: Unauthorized
                required:
                - message
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                type: object
                properties: {}
        '404':
          description: User not found for this brand.
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '429':
          description: Rate Limit Exceeded
          content:
            text/plain:
              schema:
                type: object
                properties: {}
      parameters:
      - in: path
        name: userIdOrEmail
        schema:
          type: string
        required: true
        description: Regal user UUID or exact login email.
      - in: header
        name: Authorization
        schema:
          type: string
        required: true
        description: Your Regal API Key
      - in: header
        name: accept
        schema:
          type: string
          default: application/json
      operationId: get_users-useridoremail
      summary: Get User
      description: Retrieve a single user by Regal user UUID or exact login email.
      x-readme:
        code-samples:
        - code: "curl --request GET \\\n  --url 'https://api.regal.ai/v1/users/user%40example.com' \\\n  --header 'Authorization: YOUR_REGAL_API_KEY' \\\n  --header 'accept: application/json'"
          language: shell
          name: ''
        samples-languages:
        - shell
      tags:
      - Users
  /users:
    get:
      responses:
        '200':
          description: Users returned successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 11111111-1111-4111-8111-111111111101
                        email:
                          type: string
                          example: user@example.com
                        firstName:
                          type: string
                          example: Avery
                        lastName:
                          type: string
                          example: User
                        skills:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                                example: Outbound Call
                              disabled:
                                type: boolean
                        teams:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: 22222222-2222-4222-8222-222222222202
                              name:
                                type: string
                                example: Sales Team
                        customAttributes:
                          type: object
                          properties:
                            tier:
                              type: string
                              example: gold
                            region:
                              type: string
                              example: us-east
                  nextCursor: {}
              examples:
                OK:
                  summary: OK
                  value:
                    items:
                    - id: 11111111-1111-4111-8111-111111111101
                      email: user@example.com
                      firstName: Avery
                      lastName: User
                      skills:
                      - name: Outbound Call
                      teams:
                      - id: 22222222-2222-4222-8222-222222222202
                        name: Sales Team
                      customAttributes:
                        tier: gold
                        region: us-east
                    nextCursor: null
        '400':
          description: Invalid query parameters, unknown team, or unknown queue.
          content: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Unauthorized
              examples:
                Unauthorized:
                  summary: Unauthorized
                  value:
                    message: Unauthorized
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                type: object
                properties: {}
              examples:
                Forbidden:
                  summary: Forbidden
                  value: ''
        '429':
          description: Rate Limit Exceeded
          content:
            text/plain:
              schema:
                type: object
                properties: {}
              examples:
                Rate Limit Exceeded:
                  summary: Rate Limit Exceeded
                  value: ''
      parameters:
      - in: query
        name: nextCursor
        schema:
          type: string
        description: Cursor returned from the previous response.
      - in: query
        name: size
        schema:
          type: number
        description: Number of results per page. Defaults to 25. Maximum 100.
      - in: query
        name: email
        schema:
          type: string
        description: Case-insensitive email substring filter.
      - in: query
        name: skills
        schema:
          type: string
        description: URL-encoded JSON array of skill names. User must have all listed skills.
      - in: query
        name: teams
        schema:
          type: string
        description: URL-encoded JSON array of team names. User must belong to at least one listed team.
      - in: query
        name: queues
        schema:
          type: string
        description: URL-encoded JSON array of queue names. User must be eligible for at least one listed queue.
      - in: query
        name: customAttributes
        schema:
          type: string
        description: URL-encoded JSON object of custom attribute key-value filters. Values may be strings, numbers, booleans, or null.
      - in: header
        name: Authorization
        schema:
          type: string
        required: true
        description: Your Regal API Key
      - in: header
        name: accept
        schema:
          type: string
          default: application/json
        description: ''
      summary: List Users
      description: Retrieve a list of your users.
      x-readme:
        code-samples:
        - code: "curl --request GET \\\n  --url 'https://api.regal.ai/v1/users?size=25&skills=%5B%22Outbound%20Call%22%5D&customAttributes=%7B%22tier%22%3A%22gold%22%7D' \\\n  --header 'Authorization: YOUR_REGAL_API_KEY' \\\n  --header 'accept: application/json'"
          language: shell
          name: ''
        samples-languages:
        - shell
      operationId: get_users
      tags:
      - Users
components:
  securitySchemes:
    sec0:
      type: apiKey
      name: Authorization
      in: header