List BotUsers

GET

/bot-users

Request

Query Params

apiKeyToken

string

required

attempt

string

optional

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

array[object (BotUser) {4}]

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

BotUser

Example:

BotUser

attributes

object

optional

relationships

object

optional

Example

{
    "data": [
        {
            "id": "FID001",
            "type": "BotUser",
            "attributes": {
                "name": "string",
                "vendorIdentifier": "rosalyn"
            },
            "relationships": {
                "portal": {
                    "data": {
                        "id": "FID001",
                        "type": "Portal"
                    }
                }
            }
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-07-08 10:51:21

Create BotUser

List Documents