Skip to main content
GET
/
end-users
curl "https://api.bota.dev/v1/end-users?limit=10" \
  -H "Authorization: Bearer sk_live_..."

{
  "data": [
    {
      "id": "eu_abc123",
      "external_id": "user_12345",
      "email": "john@example.com",
      "name": "John Doe",
      "metadata": {
        "plan": "pro"
      },
      "created_at": "2025-01-15T10:30:00Z"
    },
    {
      "id": "eu_def456",
      "external_id": "user_67890",
      "email": "jane@example.com",
      "name": "Jane Smith",
      "metadata": null,
      "created_at": "2025-01-14T09:00:00Z"
    }
  ],
  "has_more": true
}
Retrieve a paginated list of end users in your project.

​
Authentication

Requires an API key with end_users:read scope. 
curl "https://api.bota.dev/v1/end-users?limit=10" \
  -H "Authorization: Bearer sk_live_..."

​
Query Parameters

​
limit
integer
default:"25"
Maximum number of items to return (1-100).
​
offset
integer
default:"0"
Number of items to skip for pagination.

​
Response

Returns a paginated list of end user objects. 
{
  "data": [
    {
      "id": "eu_abc123",
      "external_id": "user_12345",
      "email": "john@example.com",
      "name": "John Doe",
      "metadata": {
        "plan": "pro"
      },
      "created_at": "2025-01-15T10:30:00Z"
    },
    {
      "id": "eu_def456",
      "external_id": "user_67890",
      "email": "jane@example.com",
      "name": "Jane Smith",
      "metadata": null,
      "created_at": "2025-01-14T09:00:00Z"
    }
  ],
  "has_more": true
}

​
Response Fields

FieldTypeDescription
dataarrayArray of end user objects.
has_morebooleanWhether there are more results beyond this page.
Each end user object in data contains:
FieldTypeDescription
idstringUnique identifier for the end user (prefixed with eu_).
external_idstringYour system’s unique identifier for this user.
emailstringUser’s email address.
namestringUser’s display name.
metadataobjectArbitrary key-value metadata.
created_atstringISO 8601 timestamp of when the end user was created.