Skip to main content
GET
/
v1
/
users
List users
curl --request GET \
  --url https://api.botdog.io/v1/users \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "email": "user@example.com",
    "name": "John Doe",
    "createdAt": "2023-04-02T12:00:00.000Z"
  }
]

Authorizations

​
x-api-key
string
header
default:bd_live_your_key_here
required

Query Parameters

​
limit
number

Limit the number of results

Response

List of users

​
id
string
required

The unique identifier for the user

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
email
string
required

The user's email address

Example:

"user@example.com"

​
name
string
required

The user's name

Example:

"John Doe"

​
createdAt
string<date-time>
required

When the user was created

Example:

"2023-04-02T12:00:00.000Z"