Agents

List agents

get
/agents

Retrieves a collection of agents for a company with a given ID

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Query parameters
organizationIdintegerOptionalExample: 11
Responses
200

Successful response

application/json
get
/agents
200

Successful response

Get agent details

get
/agents/{agentId}

Retrieves an agents for a agent with given ID

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
agentIdstring · uuidRequired

The ID of the agent.

Example: 78781d1f-8cc0-4f42-8e77-c02812f78b53
Query parameters
organizationIdintegerOptionalExample: 11
Responses
200

Successful response

application/json
get
/agents/{agentId}
200

Successful response

Create agent

post
/agents/{agentId}

Creates a new agent

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
agentIdstring · uuidRequired

The ID of the agent.

Example: 78781d1f-8cc0-4f42-8e77-c02812f78b53
Query parameters
organizationIdintegerOptionalExample: 11
Body
namestringRequired
Responses
200

Successful response

application/json
post
/agents/{agentId}
200

Successful response

Delete agent

delete
/agents/{agentId}

Removes an agent with a given ID.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
agentIdstring · uuidRequired

The ID of the agent.

Example: 78781d1f-8cc0-4f42-8e77-c02812f78b53
Query parameters
organizationIdintegerOptionalExample: 11
Responses
200

Successful response

application/json
delete
/agents/{agentId}
200

Successful response

Update agent

patch
/agents/{agentId}

Updates a new agent with given ID

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
agentIdstring · uuidRequired

The ID of the agent.

Example: 78781d1f-8cc0-4f42-8e77-c02812f78b53
Query parameters
organizationIdintegerOptionalExample: 11
Body
namestringOptional
Responses
200

Successful response

application/json
patch
/agents/{agentId}
200

Successful response

Last updated