Skip to main content
GET
/
management
/
v2.0
/
users
Get users.
curl --request GET \
  --url https://api-trial.cognigy.ai/new/management/v2.0/users \
  --header 'Authorization: Basic <encoded-value>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "_id": "<string>",
      "createdAt": 1694518620,
      "lastChanged": 1694518620,
      "createdBy": "<string>",
      "lastChangedBy": "<string>"
    }
  ],
  "total": 1,
  "next": "<string>",
  "previous": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic Authentication used by routes designed for the Management-UI.

Headers

​
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Query Parameters

​
filter
string

The name or id of the user to filter the records

​
limit
integer

The maximum number of items to return. The default is 25.

Required range: 1 <= x <= 100
​
skip
integer

The number of items to skip. The default is 0. Used along with a limit of a pagination.

Required range: x >= 0
​
sort
string

The order of the sorting items-desc (descending) or asc (ascending). For example, to sort the records by name in ascending order, specify name:asc.

Minimum length: 1
​
next
string

This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination.

Required string length: 24
​
previous
string

This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination.

Required string length: 24

Response

Returns metadata objects for each user in the system.

​
items
object[]
​
total
integer
Example:

1

​
next
string | null
Required string length: 24
​
previous
string | null
Required string length: 24