NiCE

NiCE Agents API

:Updated in v34.0 Agent Management

GitHub OpenAPI

Operations 53

GET /agents Updated in v34.0 Get Agents List #
POST /agents Updated in v34.0 Create an agent #
PUT /agents Updated in v34.0 Update an array of agents #
GET /agents/{agentId|userId} Updated in v34.0 Returns agent details by Agent ID #
PUT /agents/{agentId|userId} Updated in v34.0 Update Agent by Agent ID #
POST /agents/{agentId}/state Sets an Agent's State #
GET /agents/skills Returns Skills assigned to all agents #
POST /agents/skills Add or Modify skill assignments for multiple agent #
POST /agents/search Get Agents that are assigned to Multiple agents #
POST /skills/agents/search Get Agents that are assigned to Multiple Skills #
GET /agents/{agentId}/agent-configuration Returns agent configuration details for an agent with generic properties #
GET /agents/{agentId}/groups Returns a list of groups an agent is assigned #
GET /agents/{agentId|userId}/skills Returns Skills assigned to an agent #
POST /agents/{agentId|userId}/skills Assigns Skills to an Agent #
PUT /agents/{agentId|userId}/skills Modify Skill assignments for an Agent #
DELETE /agents/{agentId|userId}/skills Remove Skill assignments for an Agent #
GET /agents/{agentId}/skills/unassigned Returns Skills not assigned to an Agent #
GET /agents/skill-data Returns summary of all agent's contacts by skill #
GET /agents/{agentId}/skill-data Returns summary of an agent's contacts by skill #
PUT /agents/{agentId}/custom-event Creates a Custom Agent Event #
GET /agents/quick-replies Returns a list of Quick Replies #
GET /agents/{agentId}/quick-replies Returns a list of Quick Replies for an Agent #
POST /agents/messages Create an Agent message #
DELETE /agents/messages/{messageId} Delete agent message #
GET /agents/{agentId}/messages Returns an Agent Message List #
GET /agents/{agentId}/indicators Returns an Agent Indicator List #
POST /agents/{agentId}/logout Forces an agent session to end #
GET /agent-patterns Returns Agent Dialing patterns #
POST /agent-patterns/{agentpatternId}/transform-phonenumbers Transform Input Number #
GET /agents-states Returns a list of Agent States #
GET /agents/extended Get Agents Extended #
GET /agents/issues Lists all agent issues #
GET /agent-messages/{messageGroupId} Lists agent group messages #
GET /agents/skills-download Lists existing skills for download #
GET /teams Updated in v34.0 Returns list of Teams #
POST /teams Updated in v34.0 This method will create a new Team in the business unit #
GET /teams/{teamId} Updated in v34.0 Get Team by TeamId #
PUT /teams/{teamId} Updated in v34.0 This method updates the Team specified by teamId #
GET /teams/agents Updated in v34.0 Get list of teams and their agents #
GET /teams/{teamId}/agents Updated in v34.0 Get list of teams and their agents #
POST /teams/{teamId}/agents Updated in v34.0 Assign Agents to a Team #
DELETE /teams/{teamId}/agents Updated in v34.0 Remove Agents from a Team #
GET /teams/{teamId}/unavailable-codes Updated in v34.0 Gets all outstates that are valid for a team #
POST /teams/{teamId}/unavailable-codes Updated in v34.0 Assign an Unavailable Code to a Team #
PUT /teams/{teamId}/unavailable-codes Updated in v34.0 Updates an Unavailable Code for a Team #
DELETE /teams/{teamId}/unavailable-codes Updated in v34.0 Remove an Unavailable Code from a Team #
GET /access-keys Returns a list of access keys #
POST /access-keys Creates an accessKey #
GET /access-keys/{accessKeyId} Returns the configuration of an accessKey #
DELETE /access-keys/{accessKeyId} Deletes an accessKey #
PATCH /access-keys/{accessKeyId} Updates an accessKey by Id #
GET /activesupervisors Returns Active supervisors status #
POST /enhancedcustomercard New in v33.0 A New proxy API endpoint within the monolith application that… #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/nice/openapi/nice-agents-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/nice:nice-agents-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. 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

nice-agents-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Nice Agents API
  version: v1
  description: 'Operations tagged Agents across 2 of this provider''s published API definitions: nice-admin-agents.json, nice-admin-agents-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:


# --- truncated at 32 KB (459 KB total) ---
# Full source: https://artifacts.apis.io/nice/openapi/nice-agents-api-openapi.yml