NiCE Customer API

: Customer Management

GitHub OpenAPI

Operations 9

GET /customers Get list of Customers based on filter #
GET /customers/{customerId} Get detail of the customer #
GET /customers/{customerId}/notes Get list of customer notes #
POST /customers/{customerId}/notes Create customer note #
PUT /customers/{customerId}/notes/{noteId} Update customer note #
DELETE /customers/{customerId}/notes/{noteId} Delete customer note #
PUT /customers/{customerId}/merge Merge customer with another customer #
DELETE /customers/{customerId}/custom-fields/{customFieldIdentifier} Remove custom field value from Customer #
PUT /customers/{customerId}/custom-fields Update values of customer custom fields #

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-customer-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-customer-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nice Customer API
  version: v1
  description: 'Operations tagged Customer across 2 of this provider''s published API definitions: nice-digital-customer.json, nice-digital-customer-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Customer
  description: ': Customer Management'
paths:
  /customers:
    get:
      tags:
      - Customer
      summary: Get list of Customers based on filter
      operationId: searchCustomers
      parameters:
      - name: query
        in: query
        schema:
          type: string
        description: Customer query search
        examples:
          notSimilar:
            summary: Field value is not similar
            value: NOT (fullName ~ john)
          idOnExternalPlatformEquals:
            summary: ID on external platform equals a value
            value: identityIdOnExternalPlatform = 123456efa
          multipleValuesSearch:
            summary: Use multiple search values for field
            value: identityIdOnExternalPlatform IN (123456efa, bc6582)
        required: false
      - name: limit
        in: query
        description: Maximum count of returned entities per page.
        required: false
        schema:
          type: integer
      - $ref: '#/components/parameters/page'
      - name: orderBy
        in: query
        description: Sort strategy name
        schema:
          type: string
          enum:
          - relevance
          - createdAt
          - updatedAt
          - firstName
          - lastName
          - firstInteractionAt
          - lastInteractionAt
          - numberOfInbounds
          - numberOfOutbounds
          default: createdAt
      - $ref: '#/components/parameters/order'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  hits:
                    type: integer
                    example: 1
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Customer'
        '400':
          description: Some of the arguments were invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorCollection'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorCollection'
  /customers/{customerId}:
    get:
      tags:
      - Customer
      summary: Get detail of the customer
      operationId: getCustomer
      parameters:
      - $ref: '#/components/parameters/customerId'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorCollection'
        '404':
          description: Customer not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorCollection'
  /customers/{customerId}/notes:
    get:
      tags:
      - Customer
      summary: Get list of customer notes
      operationId: getCustomerNotes
      parameters:
      - $ref: '#/components/parameters/customerId'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalRecords:
                    type: integer
                    example: 1
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CustomerNote'
                  _links:
                    $ref: '#/components/schemas/Links'
        '400':
          description: Something went wrong
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorCollection'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorCollection'
    post:
      tags:
      - Customer
      summary: Create customer note
      operationId: createCustomerNote
      parameters:
      - $ref: '#/components/parameters/customerId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - content
              properties:
                content:
                  type: string
                  description: Text content of the customer note
            example:
              content: note content text
      responses:
        '201':
          description: Customer note has been added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerNote'
        '400':
          description: Customer note hasn't been added due to an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorCollection'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorCollection'
  /customers/{customerId}/notes/{noteId}:
    put:
      tags:
      - Customer
      summary: Update customer note
      operationId: updateCustomerNote
      parameters:
      - $ref: '#/components/parameters/customerId'
      - $ref: '#/components/parameters/customerNoteId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - content
              properties:
                content:
                  type: string
                  description: Text content of the customer note
            example:
              content: note content text
      responses:
        '200':
          description: Customer note has been updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerNote'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorCollection'
        '404':
          description: Customer note was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorCollection'
    delete:
      tags:
      - Customer
      summary: Delete customer note
      operationId: deleteCustomerNote
      parameters:
      - $ref: '#/components/parameters/customerId'
      - $ref: '#/components/parameters/customerNoteId'
      responses:
        '204':
          description: Customer note has been deleted
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorCollection'
        '404':
          description: Customer note was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorCollection'
  /customers/{customerId}/merge:
    put:
      tags:
      - Customer
      summary: Merge customer with another customer
      operationId: mergeCustomer
      parameters:
      - $ref: '#/components/parameters/customerId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                customerToMerge:
                  type: object
                  properties:
                    id:
                      type: string
                      description: ID of the customer to merge with
            example:
              customerToMerge:
                id: customer-to-merge-id
      responses:
        '204':
          description: Customer was merged
        '400':
          description: Customer was not merged
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorCollection'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorCollection'
        '404':
          description: Customer was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorCollection'
  /customers/{customerId}/custom-fields/{customFieldIdentifier}:
    delete:
      tags:
      - Customer
      summary: Remove custom field value from Customer
      operationId: removeCustomerCustomFieldValue
      parameters:
      - $ref: '#/components/parameters/customerId'
      - $ref: '#/components/parameters/customFieldIdentifier'
      responses:
        '204':
          description: Custom field value was removed from Customer
        '400':
          description: Custom field value in Customer cannot be removed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorCollection'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorCollection'
        '404':
          description: Customer or Custom field value in Customer was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorCollection'
        '409':
          description: Custom field value was not removed from Contact due to version conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorCollection'
  /customers/{customerId}/custom-fields:
    put:
      tags:
      - Customer
      summary: Update values of customer custom fields
      operationId: updateCustomerCustomFields
      parameters:
      - $ref: '#/components/parameters/customerId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/CustomField'
      responses:
        '200':
          description: Custom fields' values were updated
        '400':
          description: Custom fields values were not updated due to an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorCollection'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorCollection'
components:
  parameters:
    page:
      name: page
      in: query
      description: Page number (1-N)
      required: false
      schema:
        type: integer
        minimum: 1
        default: 1
    customFieldIdentifier:
      name: customFieldIdentifier
      in: path
      description: Custom field identifier
      required: true
      schema:
        type: string
    customerId:
      name: customerId
      in: path
      description: ID of the Customer
      required: true
      schema:
        type: string
    order:
      name: order
      in: query
      description: Sort order direction
      required: false
      schema:
        type: string
        enum:
        - asc
        - desc
    customerNoteId:
      name: noteId
      in: path
      description: ID of the customer note
      required: true
      schema:
        type: string
  schemas:
    CustomerMessageStatistics:
      type: object
      properties:
        inbound:
          type: integer
          description: Number of Customer's messages in total
        outbound:
          type: integer
          description: Number of replies to the Customer in total
    AuthorCustomerIdentity:
      type: object
      required:
      - idOnExternalPlatform
      properties:
        idOnExternalPlatform:
          type: string
          description: Unique ID of user on external platform, e.g. Facebook user ID
        firstName:
          type: string
        lastName:
          type: string
        nickname:
          type: string
        image:
          type: string
          description: URL to Consumer image, it has to be availble from public internet so DFO can download the image into its own file storage.
        customFields:
          type: array
          items:
            $ref: '#/components/schemas/CustomField'
    ApiErrorCollection:
      title: Collection of API errors
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ApiError'
        uid:
          type: string
          description: UID for debug purposes
      required:
      - errors
    CustomField:
      title: Custom field value
      type: object
      properties:
        ident:
          type: string
          minLength: 1
          maxLength: 255
        value:
          type: string
          maxLength: 1024
        updatedAt:
          type: string
          format: date-time
      required:
      - ident
      - value
    CustomerNote:
      type: object
      required:
      - id
      - user
      - createdAt
      - updatedAt
      - content
      properties:
        id:
          type: string
          minLength: 1
        user:
          $ref: '#/components/schemas/User'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        content:
          type: string
    ApiError:
      title: API error
      type: object
      required:
      - message
      properties:
        field:
          type: string
          description: Name of the field containing error
        message:
          type: string
          description: Error description
        parameters:
          type: object
          description: Free dictionary of additional data describing the error state
        errorCode:
          type: string
          description: Specific code of the type of error
    Customer:
      type: object
      required:
      - id
      - updatedAt
      - identities
      - messageStatistics
      - sentimentStatistics
      properties:
        id:
          type: string
          description: Internal Customer's ID
        updatedAt:
          type: string
          format: date-time
        firstName:
          type: string
        surname:
          type: string
        fullName:
          type: string
        customFields:
          type: array
          items:
            $ref: '#/components/schemas/CustomField'
        image:
          type: string
          description: URL to Customer's avatar
          example: https://app-eu1.brandembassy.test/img/user-default.png
        identities:
          type: array
          items:
            $ref: '#/components/schemas/AuthorCustomerIdentity'
        messageStatistics:
          $ref: '#/components/schemas/CustomerMessageStatistics'
        sentimentStatistics:
          $ref: '#/components/schemas/CustomerSentimentStatistics'
    Links:
      type: object
      properties:
        self:
          type: string
        next:
          type: string
        previous:
          type: string
    User:
      type: object
      required:
      - id
      - emailAddress
      - loginUsername
      - firstName
      - surname
      - isBotUser
      - isSurveyUser
      properties:
        id:
          type: integer
          description: ID of the User (platform specific)
          example: 21543
        incontactId:
          type: string
          description: ID of the User in CXone
          example: b6925157-5e0e-4c11-8e9b-56a4078abb25
        emailAddress:
          type: string
          example: agent@cxone.com
        loginUsername:
          type: string
          description: Login username, typically an e-mail address
          example: agent@cxone.com
        firstName:
          type: string
          example: John
        surname:
          type: string
          example: Haste
        nickname:
          type: string
        imageUrl:
          type: string
          description: Path to user's avatar image
        isBotUser:
          type: boolean
          default: false
        isSurveyUser:
          type: boolean
          default: false
    CustomerSentimentStatistics:
      type: object
      properties:
        positive:
          type: integer
          description: Number of Customer's messages with positive sentiment
        neutral:
          type: integer
          description: Number of Customer's messages with neutral sentiment
        negative:
          type: integer
          description: Number of Customer's messages with negative sentiment
x-refined-from:
- nice-digital-customer.json
- nice-digital-customer-openapi.yml