Skip to main content
GET
/
management
/
v2.0
/
organisations
Get organisations.
curl --request GET \
  --url https://api-trial.cognigy.ai/new/management/v2.0/organisations \
  --header 'Authorization: Basic <encoded-value>'
{
  "items": [
    {
      "_id": "<string>",
      "businessUnitId": "<string>",
      "name": "<string>",
      "disabled": true,
      "quotaMaxProjects": 123,
      "quotaMaxUsers": 123,
      "quotaMaxChannelsPerProject": 123,
      "quotaMaxMessagesPerDay": 123,
      "quotaMaxKnowledgeChunks": 123,
      "passwordPolicy": {
        "minLength": 123,
        "maxLength": 123,
        "minAmountLowerCase": 123,
        "minAmountUpperCase": 123,
        "minAmountSpecialCharacters": 123,
        "minAmountNumbers": 123,
        "maxAmountIdenticalCharacters": 123,
        "minAmountFailedAttemptsAutoDisable": 123
      },
      "sessionStateTTLInMinutes": 123,
      "contactProfileTTLInMinutes": 123,
      "conversationTTLInMinutes": 123,
      "liveAgentAccount": 123,
      "billingTimezone": "Europe/Berlin",
      "dataPrivacySettings": {
        "enabled": true,
        "useAnalytics": true,
        "useContactProfiles": true,
        "useConversations": true,
        "maskAnalytics": true,
        "maskLogging": true,
        "ignoreList": [
          "<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 of the organisation 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 organisation in the system.

items
object[]
total
integer
Example:

1

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