Lucidya

Lucidya Ltd Reference Data API

Endpoints for fetching reference data (agents, teams, data sources)

GitHub OpenAPI
Business capability
Contact Centre Operations Management BC-430.30

Operations 5

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 /analytics/agents List my company's agents · Get Agents #
Ask an LLM
“Who are the active agents in my company account?”
“Can I get the list of agent users to filter analytics by agent?”
Tell an agent
List all active agents in my company.
Show me every agent user on our account.
GET /analytics/teams List my company's teams · Get Teams #
Ask an LLM
“Which teams are set up in my company?”
“What team IDs can I use in analytics filters?”
Tell an agent
List all teams in my company.
Show the teams configured on our account.
GET /analytics/data_sources List data sources available to my company · Get Data Sources #
Ask an LLM
“Which data sources are available for my company?”
“What data source names can I pass to CSAT or analytics calls?”
Tell an agent
List all data sources available to my company.
Show the data sources connected to our account.
GET /analytics/routings List inbound routings · Get Routings #
Ask an LLM
“Which inbound routing rules does my company have?”
“How are incoming conversations routed in our account?”
Tell an agent
List all inbound routings for my company.
Show our configured conversation routings.
GET /analytics/slas List SLAs and their time thresholds · Get SLAs #
Ask an LLM
“What SLA policies do we have and what are their time thresholds?”
“Which SLAs can I filter analytics by?”
Tell an agent
List all SLAs with their time thresholds.
Show the SLA policies configured for my company.

Documentation

📖
Documentation
https://docs.lucidya.com/docs/Social-Listening-api/rqwky70duwx76-get-started
📖
APIReference
https://docs.lucidya.com/docs/Social-Listening-api/wainb9dny9w1y-lucidya-social-listening-public-api
📖
GettingStarted
https://docs.lucidya.com/docs/Social-Listening-api/rqwky70duwx76-get-started
📖
Authentication
https://docs.lucidya.com/docs/Social-Listening-api/uh64vtmx7x4kl-authorization
📖
Documentation
https://docs.lucidya.com/docs/ai-api/l9nsga0nmis4v-get-started
📖
APIReference
https://docs.lucidya.com/docs/ai-api/zl9th61r4qjdz-lucidya-public-ai-api
📖
GettingStarted
https://docs.lucidya.com/docs/ai-api/l9nsga0nmis4v-get-started
📖
Authentication
https://docs.lucidya.com/docs/ai-api/sjq8uo8o8lt93-authorization
📖
Documentation
https://docs.lucidya.com/docs/cdp-api/lnrpbrm3b9yp9-get-started
📖
APIReference
https://docs.lucidya.com/docs/cdp-api/ns8sfqyr1dgw6-cdp-customer-data-platform-api
📖
GettingStarted
https://docs.lucidya.com/docs/cdp-api/lnrpbrm3b9yp9-get-started
📖
Authentication
https://docs.lucidya.com/docs/cdp-api/6tqmgs82r4jxa-authorization
📖
Documentation
https://docs.lucidya.com/docs/omnichannel-api/q1nc0ntpokxgs-get-started
📖
APIReference
https://docs.lucidya.com/docs/omnichannel-api/d1ow4caem6i5x-omni-channel-api
📖
GettingStarted
https://docs.lucidya.com/docs/omnichannel-api/q1nc0ntpokxgs-get-started
📖
Authentication
https://docs.lucidya.com/docs/omnichannel-api/cfqqlsohea8mv-authorization
📖
Documentation
https://docs.lucidya.com/docs/omniserve/jjdvsz08tba5c-get-started
📖
APIReference
https://docs.lucidya.com/docs/omniserve/mjhuba7fdw882-omni-serve-analytics-api
📖
GettingStarted
https://docs.lucidya.com/docs/omniserve/jjdvsz08tba5c-get-started
📖
Authentication
https://docs.lucidya.com/docs/omniserve/8s65uy0al6adj-authorization

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lucidya-ltd/refs/heads/main/openapi/lucidya-ltd-reference-data-api-openapi.yml

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/lucidya-ltd:lucidya-ltd-reference-data-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

lucidya-ltd-reference-data-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.0.0
  title: OmniServe Analytics Reference Data API
  description: 'Complete API collection for Lucidya OmniServe Analytics Endpoints. This API provides access to

    analytics data for engagement monitoring, CSAT surveys, and reporting capabilities.


    Features include:

    - Analytics pages and widgets discovery

    - Job-based analytics data retrieval

    - CSAT survey analytics

    - Reference data access (agents, teams, data sources)'
  contact:
    name: API Support
    email: support@lucidya.com
    url: https://lucidya.com
  license:
    url: https://opensource.org/licenses/MIT
    name: MIT
servers:
- url: https://api.lucidya.com/public_api/omniserve
  description: Production Server
security:
- OmniserveToken: []
tags:
- name: Reference Data
  description: Endpoints for fetching reference data (agents, teams, data sources)
paths:
  /analytics/agents:
    get:
      tags:
      - Reference Data
      summary: Get Agents
      description: This endpoint enables you to get all agents (active users) for the current company.
      operationId: getAgents
      responses:
        '200':
          description: Agents list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 101
                        name:
                          type: string
                          example: Agent One
                        status:
                          type: string
                          example: available
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '406':
          $ref: '#/components/responses/NotAcceptable'
        '410':
          $ref: '#/components/responses/Gone'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '504':
          $ref: '#/components/responses/GatewayTimeout'
      security:
      - OmniserveToken: []
      servers:
      - url: https://api.lucidya.com/public_api/omniserve
        description: Production Server
  /analytics/teams:
    get:
      tags:
      - Reference Data
      summary: Get Teams
      description: This endpoint enables you to get all teams for the current company.
      operationId: getTeams
      responses:
        '200':
          description: Teams list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 11
                        name:
                          type: string
                          example: Support
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '406':
          $ref: '#/components/responses/NotAcceptable'
        '410':
          $ref: '#/components/responses/Gone'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '504':
          $ref: '#/components/responses/GatewayTimeout'
      security:
      - OmniserveToken: []
      servers:
      - url: https://api.lucidya.com/public_api/omniserve
        description: Production Server
  /analytics/data_sources:
    get:
      tags:
      - Reference Data
      summary: Get Data Sources
      description: This endpoint enables you to get all available data sources for the current company.
      operationId: getDataSources
      responses:
        '200':
          description: Data sources list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        name:
                          type: string
                          example: twitter
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '406':
          $ref: '#/components/responses/NotAcceptable'
        '410':
          $ref: '#/components/responses/Gone'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '504':
          $ref: '#/components/responses/GatewayTimeout'
      security:
      - OmniserveToken: []
      servers:
      - url: https://api.lucidya.com/public_api/omniserve
        description: Production Server
  /analytics/routings:
    get:
      tags:
      - Reference Data
      summary: Get Routings
      description: This endpoint enables you to get all inbound routings for the current company.
      operationId: getRoutings
      responses:
        '200':
          description: Routings list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 62
                        name:
                          type: string
                          example: High Priority Routing
              examples:
                default:
                  value:
                    data:
                    - id: 62
                      name: High Priority Routing
                    - id: 77
                      name: Default Routing
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '406':
          $ref: '#/components/responses/NotAcceptable'
        '410':
          $ref: '#/components/responses/Gone'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '504':
          $ref: '#/components/responses/GatewayTimeout'
      security:
      - OmniserveToken: []
      servers:
      - url: https://api.lucidya.com/public_api/omniserve
        description: Production Server
  /analytics/slas:
    get:
      tags:
      - Reference Data
      summary: Get SLAs
      description: This endpoint enables you to get all SLAs for the current company with their time thresholds.
      operationId: getSlas
      responses:
        '200':
          description: SLAs list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 3
                        name:
                          type: string
                          example: Standard SLA
                        first_response_time:
                          type: object
                          properties:
                            value:
                              type: integer
                              example: 15
                            unit:
                              type: string
                              example: minutes
                        next_response_time:
                          type: object
                          properties:
                            value:
                              type: integer
                              example: 30
                            unit:
                              type: string
                              example: minutes
                        time_to_complete:
                          type: object
                          properties:
                            value:
                              type: integer
                              example: 240
                            unit:
                              type: string
                              example: minutes
                        total_unassigned_time:
                          type: object
                          properties:
                            value:
                              type: integer
                              example: 60
                            unit:
                              type: string
                              example: minutes
              examples:
                default:
                  value:
                    data:
                    - id: 3
                      name: Standard SLA
                      first_response_time:
                        value: 15
                        unit: minutes
                      next_response_time:
                        value: 30
                        unit: minutes
                      time_to_complete:
                        value: 240
                        unit: minutes
                      total_unassigned_time:
                        value: 60
                        unit: minutes
                    - id: 4
                      name: VIP SLA
                      first_response_time:
                        value: 5
                        unit: minutes
                      next_response_time:
                        value: 15
                        unit: minutes
                      time_to_complete:
                        value: 120
                        unit: minutes
                      total_unassigned_time:
                        value: 15
                        unit: minutes
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '406':
          $ref: '#/components/responses/NotAcceptable'
        '410':
          $ref: '#/components/responses/Gone'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '504':
          $ref: '#/components/responses/GatewayTimeout'
      security:
      - OmniserveToken: []
      servers:
      - url: https://api.lucidya.com/public_api/omniserve
        description: Production Server
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            status:
              type: integer
              example: 400
            detail:
              type: string
              example: Page_id is required
        status:
          type: integer
          example: 400
        message:
          type: string
          example: Error message
        code:
          type: string
          example: ERROR_CODE
  responses:
    ValidationFailed:
      description: Unprocessable Entity - validation failed or missing required fields
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 422
                message: Validation failed
    ServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 500
                message: Internal server error
    NotAcceptable:
      description: Not Acceptable - the requested format is not supported
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 406
                message: Not acceptable
    Unauthorized:
      description: Unauthorized - invalid or missing authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 401
                message: Authentication required
    Gone:
      description: Gone - the requested resource is no longer available
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 410
                message: Resource gone
    Forbidden:
      description: Forbidden - insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 403
                message: Access denied
    NotFound:
      description: Not Found - the specified resource could not be found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 404
                message: Resource not found
    BadRequest:
      description: Bad request - invalid input or validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 400
                detail: Page_id is required
    MethodNotAllowed:
      description: Method Not Allowed - HTTP method is not supported for this endpoint
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 405
                message: Method not allowed
    ServiceUnavailable:
      description: Service Unavailable - temporary server overload or maintenance
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 503
                message: Service unavailable
    RateLimited:
      description: Too many requests - rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 429
                message: Rate limit exceeded
                retry_after: 60
    GatewayTimeout:
      description: Gateway Timeout - server took too long to respond
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 504
                message: Gateway timeout
  securitySchemes:
    OmniserveToken:
      type: apiKey
      description: The API authorization token for the request
      name: luc-authorization
      in: header
      x-example: YOUR_API_TOKEN_HERE