Skip to main content
GET
/
bot_users
List
curl --request GET \
  --url https://api.ngrok.com/bot_users \
  --header 'Authorization: Bearer <token>' \
  --header 'ngrok-version: <ngrok-version>'
{
  "bot_users": [
    {
      "id": "<string>",
      "uri": "<string>",
      "name": "<string>",
      "active": true,
      "created_at": "<string>"
    }
  ],
  "uri": "<string>",
  "next_page_uri": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://ngrok.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Use the Service User endpoints instead. Bot Users will soon be deprecated.

Authorizations

​
Authorization
string
header
required

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

Headers

​
ngrok-version
integer
default:2
required

Query Parameters

​
before_id
string
​
limit
string

Response

200 - application/json

List all bot users in this account.

​
bot_users
object[]

the list of all bot users on this account

​
uri
string

URI of the bot users list API resource

​
next_page_uri
string

URI of the next page, or null if there is no next page