# NiCE Agents API

**Canonical:** https://apis.io/apis/nice/nice-agents-api/  
**Provider:** NiCE — https://apis.io/providers/nice/  
**Base URL:** https://api-na1.niceincontact.com  
**Documentation:** https://developer.niceincontact.com/API/AdminAPI

NiCE Agents API is one of 92 APIs that [NiCE](https://apis.io/providers/nice/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Agents. The published artifact set on APIs.io includes an OpenAPI specification.

:Updated in v34.0 Agent Management

## Operations (53)

| Method | Path | Summary |
|---|---|---|
| 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… |

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/nice/openapi/nice-agents-api-openapi.yml

## Other NiCE APIs (12)

- [NiCE Access Keys API](https://apis.io/apis/nice/nice-accesskeys-api/)
- [NiCE Agent Messaging API](https://apis.io/apis/nice/nice-agentmessaging-api/)
- [NiCE Agent Phone API](https://apis.io/apis/nice/nice-agentphone-api/)
- [NiCE Analyzed Interaction Segments API](https://apis.io/apis/nice/nice-analyzed-interaction-segments-api/)
- [NiCE Applications API](https://apis.io/apis/nice/nice-applications-api/)
- [NiCE Association API](https://apis.io/apis/nice/nice-association-api/)
- [NiCE Attachment API](https://apis.io/apis/nice/nice-attachment-api/)
- [NiCE Authenticate API](https://apis.io/apis/nice/nice-authenticate-api/)
- [NiCE Authorization Management API](https://apis.io/apis/nice/nice-authorizationmanagement-api/)
- [NiCE Authorize API](https://apis.io/apis/nice/nice-authorize-api/)
- [NiCE Billing - ProductUsage API](https://apis.io/apis/nice/nice-billing-productusage-api/)
- [NiCE Business Data API](https://apis.io/apis/nice/nice-businessdata-api/)

## Tags

Agents

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/nice/nice-agents-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/nice/.