Skip to main content
GET
/
bots
List bots
curl --request GET \
  --url https://api.helloannie.com/v1/bots
{
  "success": true,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "internalName": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "companyName": "<string>",
      "industry": "DENTAL",
      "greeting": "<string>",
      "phoneGreeting": "<string>",
      "closedChatGreeting": "<string>",
      "closedPhoneGreeting": "<string>",
      "outbound": false,
      "isRagEnabled": false,
      "isGuardianEnabled": true,
      "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Query Parameters

​
orgId
string<uuid>

Filter bots by a specific organization orgId

​
includeChildren
boolean
default:false

Include bots from child organizations. Uses the orgId if provided, otherwise uses the authenticated organization.

Response

Response returned when listing bots

​
success
enum<boolean>
required
Available options:
true
​
data
object[]
required