Skip to main content
GET
/
api
/
v1
/
agent
/
{agent}
Get an agent
curl --request GET \
  --url https://supmaya.com/api/v1/agent/{agent} \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "name": "<string>",
  "questions": "<string>",
  "knowledge_base": "<string>",
  "booking_link": "<string>",
  "webhook_url": "<string>",
  "webhook_zapier": "<string>",
  "show_heading": true,
  "active": true,
  "customisation": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agent
integer<int64>
required

Agent ID

Response

Agent

id
integer<int64>
name
string
questions
string | null
knowledge_base
string | null
webhook_url
string<uri> | null
webhook_zapier
string | null
show_heading
boolean
active
boolean
customisation
object
created_at
string<date-time> | null
updated_at
string<date-time> | null