Chatbots. The agents this token can use.
List the account's chatbots and read one. Every other endpoint starts from a chatbot's ID.
On this page
List chatbots
/chatbotsThe chatbots this token may use: all of the account's, or only those the token is limited to. Newest first.
Permission: chatbots:read
Query parameters
limitItems per page, 1 to 100. Default 20.
cursormeta.pagination.nextCursor from the previous page.
curl https://get-api.simplyboost.io/api/v1/chatbots \
-H "Authorization: Bearer $SIMPLYBOOST_TOKEN"Response 200 OK
{
"ok": true,
"data": {
"chatbots": [
{
"id": "f45268b2-1980-470d-865d-5048a89aedce",
"name": "Support agent",
"status": "active",
"roles": ["SUPPORT"],
"language": "auto",
"createdAt": "2026-06-02T08:15:00+00:00",
"updatedAt": "2026-10-01T12:40:00+00:00"
}
]
},
"meta": {
"requestId": "req_…",
"pagination": { "limit": 20, "hasMore": false, "nextCursor": null }
}
}Response fields
data.chatbots[].idThe chatbot's ID.
data.chatbots[].nameIts name.
data.chatbots[].statusactive or archived.
data.chatbots[].rolesSUPPORT, LEAD_GEN and/or COMMERCE.
data.chatbots[].languageReply language, or auto to answer in the visitor's language.
data.chatbots[].createdAtWhen it was created.
data.chatbots[].updatedAtWhen its settings last changed.
meta.paginationlimit, hasMore (true when there is another page) and nextCursor (null on the last page).
Errors
| Status | Code | When |
|---|---|---|
| 400 | validation_error | limit or cursor is not valid. |
Get a chatbot
/chatbots/{chatbotId}One chatbot, with the same fields as in the list.
Permission: chatbots:read
Path parameters
chatbotIdThe chatbot. Listed by GET /chatbots.
curl https://get-api.simplyboost.io/api/v1/chatbots/CHATBOT_ID \
-H "Authorization: Bearer $SIMPLYBOOST_TOKEN"Response 200 OK
{
"ok": true,
"data": { "chatbot": { "id": "f45268b2-…", "name": "Support agent", "status": "active", … } },
"meta": { "requestId": "req_7c1e4b2a9f0d4e6c8b3a5d7f9e1c2b4a" }
}Response fields
data.chatbotThe chatbot: id, name, status, roles, language, createdAt, updatedAt.
Errors
| Status | Code | When |
|---|---|---|
| 404 | not_found | No such chatbot, or this token may not see it. |