NiCE Groups API

: Group Management

GitHub OpenAPI

Operations 7

GET /groups Get Groups #
POST /groups Create Groups #
GET /groups/{groupId} Returns a group config #
PUT /groups/{groupId} Updates a Group #
GET /groups/{groupId}/agents Returns a list of agents assigned to a group #
POST /groups/{groupId}/agents Assigns Agents to a Group #
DELETE /groups/{groupId}/agents Removes agents from a group #

Specifications

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-groups-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.

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

OpenAPI Specification

nice-groups-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nice Groups API
  version: v1
  description: 'Operations tagged Groups across 2 of this provider''s published API definitions: nice-admin-groups.json, nice-admin-groups-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Groups
  description: ': Group Management'
paths:
  /groups:
    get:
      tags:
      - Groups
      summary: Get Groups
      description: 'This method returns an array of groups with fields values for a business unit.


        NOTE: In CXone User Hub, this API is not applicable and should not be used to retrieve group records. It only applies to the groups found in CXone Central, not those part of CXone User Hub.'
      operationId: getgroups
      parameters:
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/orderBy'
      - $ref: '#/components/parameters/searchString'
      - $ref: '#/components/parameters/isActiveNew'
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getgroupsresponse'
        '204':
          description: 'No Groups Found for BU: {0}'
          content:
            application/json:
              schema:
                type: object
                properties:
                  _links:
                    type: object
                    properties:
                      self:
                        type: string
                      next:
                        type: string
                      previous:
                        type: string
                  totalRecords:
                    type: integer
                  groups:
                    type: array
                    items:
                      type: object
                      properties:
                        groupId:
                          type: integer
                        groupName:
                          type: string
                        notes:
                          type: string
                        isActive:
                          type: boolean
                        lastUpdated:
                          type: string
        '400':
          description: Invalid {0} - '{1}' {2}
    post:
      tags:
      - Groups
      summary: Create Groups
      description: 'This method creates a group and returns a groupId.


        NOTE: In CXone User Hub, this API is not applicable and should not be used to create group records. It only applies to the groups found in CXone Central, not those part of CXone User Hub.'
      operationId: postgroups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postgroupsrequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postgroupsresponse'
        '206':
          description: One or more groups were not created
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorCount:
                    type: integer
                  groupResults:
                    type: array
                    items:
                      type: object
                      properties:
                        success:
                          type: boolean
                        groupId:
                          type: integer
                        error:
                          type: string
        '400':
          description: Invalid groups
        '409':
          description: <p>Invalid Permissions</p>
  /groups/{groupId}:
    get:
      tags:
      - Groups
      summary: Returns a group config
      description: 'This method returns the configuration for a group.


        NOTE: In CXone User Hub, this API is not applicable and should not be used to retrieve group records. It only applies to the groups found in CXone Central, not those part of CXone User Hub.'
      operationId: getgroupsbygroupid
      parameters:
      - name: groupId
        in: path
        required: true
        description: Group Id
        schema:
          type: integer
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getgroupgroupidresponse'
        '400':
          description: Invalid groupId
        '404':
          description: 'Group {0} not found for BU: {1}'
    put:
      tags:
      - Groups
      summary: Updates a Group
      description: 'This method modifies a group.


        NOTE: In CXone User Hub, this API is not applicable and should not be used to edit or update group records. It only applies to the groups found in CXone Central, not those part of CXone User Hub.'
      operationId: putgroupsbygroupid
      parameters:
      - name: groupId
        in: path
        required: true
        description: Group Id
        schema:
          type: integer
      - name: groupName
        in: query
        required: true
        description: Group Name
        schema:
          type: string
      - $ref: '#/components/parameters/isActiveNew'
      - name: notes
        in: query
        description: Notes
        schema:
          type: string
        required: false
      responses:
        '200':
          description: Success
        '400':
          description: Invalid {0} - '{1}' {2}
        '403':
          description: Invalid {0} - '{1}' {2}
        '404':
          description: 'Group {0} not found for BU: {1}'
  /groups/{groupId}/agents:
    get:
      tags:
      - Groups
      summary: Returns a list of agents assigned to a group
      description: 'This method returns a list of agents assigned to a group. Groups are an optional field set during agent configuration.


        NOTE: In CXone User Hub, this API is not applicable and should not be used to retrieve any agents assigned to group records. It only applies to the groups found in CXone Central, not those part of CXone User Hub.'
      operationId: GetGroupAgent
      parameters:
      - name: groupId
        in: path
        required: true
        description: Group Id
        schema:
          type: integer
      - name: assigned
        in: query
        description: List agents assigned or not assigned for the group
        schema:
          type: boolean
        required: false
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/orderBy'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/searchString'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  _links:
                    type: object
                    properties:
                      self:
                        type: string
                      next:
                        type: string
                      previous:
                        type: string
                  totalRecords:
                    type: integer
                  agents:
                    type: array
                    items:
                      type: object
                      properties:
                        agentId:
                          type: integer
                        userName:
                          type: string
                          minLength: 1
                          pattern: ^[a-zA-Z0-9.'_%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,30}$
                        firstName:
                          type: string
                          minLength: 1
                          maxLength: 50
                        middleName:
                          type: string
                          maxLength: 50
                        lastName:
                          type: string
                          minLength: 1
                          maxLength: 50
                        emailAddress:
                          type: string
                          minLength: 1
                          pattern: ^[a-zA-Z0-9.'_%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,30}$
                        isActive:
                          type: boolean
                        teamId:
                          type: integer
                        teamName:
                          type: string
                        reportToId:
                          type: integer
                        reportToName:
                          type: string
                        isSupervisor:
                          type: boolean
                        lastLogin:
                          type: string
                        lastUpdated:
                          type: string
                        location:
                          type: string
                        custom1:
                          type: string
                        custom2:
                          type: string
                        custom3:
                          type: string
                        custom4:
                          type: string
                        custom5:
                          type: string
                        internalId:
                          type: string
                        profileId:
                          type: integer
                        profileName:
                          type: string
                        timeZone:
                          type: string
                          minLength: 1
                        country:
                          type: string
                          minLength: 1
                        countryName:
                          type: string
                        state:
                          type: string
                        city:
                          type: string
                          minLength: 1
                        chatRefusalTimeout:
                          type: integer
                        phoneRefusalTimeout:
                          type: integer
                          minimum: 15.0
                          maximum: 300.0
                        workItemRefusalTimeout:
                          type: integer
                          minimum: 15.0
                          maximum: 300.0
                        defaultDialingPattern:
                          type: integer
                        defaultDialingPatternName:
                          type: string
                        useTeamMaxConcurrentChats:
                          type: boolean
                        maxConcurrentChats:
                          type: integer
                        notes:
                          type: string
                        createDate:
                          type: string
                        inactiveDate:
                          type: string
                        hireDate:
                          type: string
                        terminationDate:
                          type: string
                        hourlyCost:
                          type: number
                        rehireStatus:
                          type: boolean
                        employmentType:
                          type: integer
                          minimum: 1.0
                          maximum: 5.0
                        employmentTypeName:
                          type: string
                        referral:
                          type: string
                          maxLength: 30
                        atHome:
                          type: boolean
                        hiringSource:
                          type: integer
                        ntLoginName:
                          type: string
                        scheduleNotification:
                          type: integer
                        federatedId:
                          type: string
                          maxLength: 128
                        useTeamEmailAutoParkingLimit:
                          type: boolean
                        maxEmailAutoParkingLimit:
                          type: integer
                          minimum: 1.0
                          maximum: 25.0
                        sipUser:
                          type: string
                          maxLength: 100
                        systemUser:
                          type: string
                          maxLength: 100
                        systemDomain:
                          type: string
                          maxLength: 100
                        crmUserName:
                          type: string
                          maxLength: 100
                        useAgentTimeZone:
                          type: boolean
                        timeDisplayFormat:
                          type: string
                        sendEmailNotifications:
                          type: boolean
                        apiKey:
                          type: string
                        telephone1:
                          type: string
                        telephone2:
                          type: string
                        userType:
                          type: string
                        isWhatIfAgent:
                          type: boolean
                        timeZoneOffset:
                          type: string
                        requestContact:
                          type: boolean
                        chatThreshold:
                          type: integer
                          minimum: 0.0
                          maximum: 12.0
                        useTeamChatThreshold:
                          type: boolean
                        emailThreshold:
                          type: integer
                          minimum: 0.0
                          maximum: 25.0
                        useTeamEmailThreshold:
                          type: boolean
                        workItemThreshold:
                          type: integer
                          minimum: 0.0
                          maximum: 25.0
                        useTeamWorkItemThreshold:
                          type: boolean
                        contactAutoFocus:
                          type: boolean
                        useTeamContactAutoFocus:
                          type: boolean
                        useTeamRequestContact:
                          type: boolean
                        subject:
                          type: string
                          maxLength: 255
                        issuer:
                          type: string
                          maxLength: 255
                        recordingNumbers:
                          type: array
                          items:
                            type: object
                            properties:
                              number:
                                type: string
                                minLength: 1
                                maxLength: 100
                            required:
                            - number
                        isOpenIdProfileComplete:
                          type: boolean
        '204':
          description: No Agents found for group {0}
          content:
            application/json:
              schema:
                type: object
                properties:
                  _links:
                    type: object
                    properties:
                      self:
                        type: string
                      next:
                        type: string
                      previous:
                        type: string
                  totalRecords:
                    type: integer
                  agents:
                    type: array
                    items:
                      type: object
                      properties:
                        agentId:
                          type: integer
                        userName:
                          type: string
                          minLength: 1
                          pattern: ^[a-zA-Z0-9.'_%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,30}$
                        firstName:
                          type: string
                          minLength: 1
                          maxLength: 50
                        middleName:
                          type: string
                          maxLength: 50
                        lastName:
                          type: string
                          minLength: 1
                          maxLength: 50
                        emailAddress:
                          type: string
                          minLength: 1
                          pattern: ^[a-zA-Z0-9.'_%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,30}$
                        isActive:
                          type: boolean
                        teamId:
                          type: integer
                        teamName:
                          type: string
                        reportToId:
                          type: integer
                        reportToName:
                          type: string
                        isSupervisor:
                          type: boolean
                        lastLogin:
                          type: string
                        lastUpdated:
                          type: string
                        location:
                          type: string
                        custom1:
                          type: string
                        custom2:
                          type: string
                        custom3:
                          type: string
                        custom4:
                          type: string
                        custom5:
                          type: string
                        internalId:
                          type: string
                        profileId:
                          type: integer
                        profileName:
                          type: string
                        timeZone:
                          type: string
                          minLength: 1
                        country:
                          type: string
                          minLength: 1
                        countryName:
                          type: string
                        state:
                          type: string
                        city:
                          type: string
                          minLength: 1
                        chatRefusalTimeout:
                          type: integer
                        phoneRefusalTimeout:
                          type: integer
                          minimum: 15.0
                          maximum: 300.0
                        workItemRefusalTimeout:
                          type: integer
                          minimum: 15.0
                          maximum: 300.0
                        defaultDialingPattern:
                          type: integer
                        defaultDialingPatternName:
                          type: string
                        useTeamMaxConcurrentChats:
                          type: boolean
                        maxConcurrentChats:
                          type: integer
                        notes:
                          type: string
                        createDate:
                          type: string
                        inactiveDate:
                          type: string
                        hireDate:
                          type: string
                        terminationDate:
                          type: string
                        hourlyCost:
                          type: number
                        rehireStatus:
                          type: boolean
                        employmentType:
                          type: integer
                          minimum: 1.0
                          maximum: 5.0
                        employmentTypeName:
                          type: string
                        referral:
                          type: string
                          maxLength: 30
                        atHome:
                          type: boolean
                        hiringSource:
                          type: integer
                        ntLoginName:
                          type: string
                        scheduleNotification:
                          type: integer
                        federatedId:
                          type: string
                          maxLength: 128
                        useTeamEmailAutoParkingLimit:
                          type: boolean
                        maxEmailAutoParkingLimit:
                          type: integer
                          minimum: 1.0
                          maximum: 25.0
                        sipUser:
                          type: string
                          maxLength: 100
                        systemUser:
                          type: string
                          maxLength: 100
                        systemDomain:
                          type: string
                          maxLength: 100
                        crmUserName:
                          type: string
                          maxLength: 100
                        useAgentTimeZone:
                          type: boolean
                        timeDisplayFormat:
                          type: string
                        sendEmailNotifications:
                          type: boolean
                        apiKey:
                          type: string
                        telephone1:
                          type: string
                        telephone2:
                          type: string
                        userType:
                          type: string
                        isWhatIfAgent:
                          type: boolean
                        timeZoneOffset:
                          type: string
                        requestContact:
                          type: boolean
                        chatThreshold:
                          type: integer
                          minimum: 0.0
                          maximum: 12.0
                        useTeamChatThreshold:
                          type: boolean
                        emailThreshold:
                          type: integer
                          minimum: 0.0
                          maximum: 25.0
                        useTeamEmailThreshold:
                          type: boolean
                        workItemThreshold:
                          type: integer
                          minimum: 0.0
                          maximum: 25.0
                        useTeamWorkItemThreshold:
                          type: boolean
                        contactAutoFocus:
                          type: boolean
                        useTeamContactAutoFocus:
                          type: boolean
                        useTeamRequestContact:
                          type: boolean
                        subject:
                          type: string
                          maxLength: 255
                        issuer:
                          type: string
                          maxLength: 255
                        recordingNumbers:
                          type: array
                          items:
                            type: object
                            properties:
                              number:
                                type: string
                                minLength: 1
                                maxLength: 100
                            required:
                            - number
                        isOpenIdProfileComplete:
                          type: boolean
        '400':
          description: Invalid parameter
        '404':
          description: Invalid groupId - '{1}'
    post:
      tags:
      - Groups
      summary: Assigns Agents to a Group
      description: 'This method assigns an array of Agents to a Group.


        NOTE: In CXone User Hub, this API is not applicable and should not be used to create any agents assigned to group records. It only applies to the groups found in CXone Central, not those part of CXone User Hub.'
      operationId: blank
      parameters:
      - name: groupId
        in: path
        required: true
        description: Group Id
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                agents:
                  type: array
                  items:
                    type: object
                    properties:
                      agentId:
                        type: integer
        description: Array of Agents
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  agents:
                    type: array
                    items:
                      type: object
                      properties:
                        agentId:
                          type: integer
        '206':
          description: One or more agents could not be assigned to group
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorCount:
                    type: integer
                  agentResults:
                    type: array
                    items:
                      type: object
                      properties:
                        agentId:
                          type: integer
                        success:
                          type: boolean
                        error:
                          type: string
                      required:
                      - agentId
        '400':
          description: Invalid groupId - {1}
        '403':
          description: Invalid {0} - {1}, {2}
        '404':
          description: 'Group {0} not found for BU: {1}'
    delete:
      tags:
      - Groups
      summary: Removes agents from a group
      description: 'This method removes agents from a group.


        NOTE: In CXone User Hub, this API is not applicable and should not be used to delete any agents assigned to group records. It only applies to the groups found in CXone Central, not those part of CXone User Hub.'
      operationId: deleteGroupAgents
      parameters:
      - name: groupId
        in: path
        required: true
        description: Group Id
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/deletegroupgroupidrequest'
        description: Array of Agents
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deletegroupgroupidresponse'
        '206':
          description: One or more agents could not be unassigned from group
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorCount:
                    type: integer
                  agentResults:
                    type: array
                    items:
                      type: object
                      properties:
                        agentId:
                          type: integer
                        success:
                          type: boolean
                        error:
                          type: string
                      required:
                      - agentId
        '400':
          description: Invalid Parameter
        '403':
          description: <p>Unauthorized Parameter</p><p>Forbidden Check Security Profile Permissions</p>
        '404':
          description: 'Group {0} not found for BU: {1}'
components:
  parameters:
    skip:
      name: skip
      in: query
      description: Number of records to skip in the results
      schema:
        type: integer
      required: false
    searchString:
      name: searchString
      in: query
      description: Filter results to objects with the value in key fields
      schema:
        type: string
      required: false
    fields:
      name: fields
      in: query
      description: Comma separated list of elements to return in response
      schema:
        type: string
      required: false
    isActiveNew:
      name: isActive
      in: query
      description: Filter results based on active status
      schema:
        type: boolean
      required: false
    orderBy:
      name: orderBy
      in: query
      description: Values used to order results before paginating them.  Can also specify "asc" or "desc" to specify direction for example "field1 asc,field2 desc,...".  Default is asc
      schema:
        type: string
      required: false
    top:
      name: top
      in: query
      description: Number of records to return in the results
      schema:
        type: integer
      required: false
  schemas:
    getgroupsresponse:
      type: object
      properties:
        _links:
          type: object
          properties:
            self:
              type: string
            next:
              type: string
            previous:
              type: string
        totalRecords:
          type: integer
        groups:
          type: array
          items:
            type: object
            properties:
              groupId:
                type: integer
              groupName:
                type: string
              notes:
                type: string
              isActive:
                type: boolean
              lastUpdated:
                type: string
    postgroupsrequest:
      type: object
      properties:
        groups:
          type:
          - array
          - 'null'
          items:
            type:
            - object
            - 'null'
            properties:
              groupName:
                type:
                - string
                - 'null'
                minLength: 1
                maxLength: 80
              isActive:
                type: boolean
              notes:
                type:
                - string
                - 'null'
                maxLength: 2000
      required:
      - groups
    postgroupsresponse:
      type: object
      properties:
        errorCount:
          type: integer
        groupResults:
          type: array
          items:
            type: object
            properties:
              success:
                type: boolean
              groupId:
                type: integer
              error:
                type: string
    getgroupgroupidresponse:
      type: object
      properties:
        totalRecords:
          type: integer
        groups:
          type: array
          items:
            type: object
            properties:
              groupId:
                type: integer
              groupName:
                type: string
              notes:
                type: string
              isActive:
                type: boolean
              lastUpdated:
                type: string
    deletegroupgroupidresponse:
      type: object
      properties:
        errorCount:
          type: integer
        agentResults:
          type: array
          items:
            type: object
            properties:
              agentId:
                type: integer
              success:
                type: boolean
              error:
                type: string
            required:
            - agentId
    deletegroupgroupidrequest:
      type: object
      properties:
        agents:
          type: array
          items:
            type: object
            properties:
              agentId:
                type: integer
x-refined-from:
- nice-admin-groups.json
- nice-admin-groups-openapi.yml