Skip to content
Home/Agents

Agents

Manage agents in your helpdesk system

Operations

Get Agents

Request

The customer must choose an Agent from within their own system to act as Fin.

When we tell the customer about responses from Fin, the author ID will be the agent chosen to act as Fin.

Security
BearerAuth
Bodyapplication/json
object
POST
/get_agents
curl -i -X POST \
  https://helpdesk.example.com/api/fin/get_agents \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Agents retrieved successfully

Bodyapplication/json
dataArray of objects(Agent)
errorobject or null(ProblemDetails)

The error returned by the API. This is an RFC 7807 problem details object: https://www.rfc-editor.org/rfc/rfc7807.html.

Response
{
  "data": [
    { … },
    { … }
  ]
}