List end-users
List end-users with cursor-based pagination. Filter by spaceId, externalId, or email.
Pagination: startingAfter and endingBefore are mutually exclusive — pass at most one. Encoded via the x-mutually-exclusive extension below for client generators that honour it; the server enforces the constraint at runtime regardless.
/api/end-usersCookie session from Better Auth. Requires X-Org-Id header for org-scoped routes.
In: cookie
Query Parameters
Filter by external ID (exact match)
Filter by email address (exact match)
Case-insensitive substring match across name, email, and external ID
Maximum number of end-users to return
201 <= value <= 100Cursor for forward pagination (end-user ID to start after)
Cursor for backward pagination (end-user ID to end before)
Header Parameters
Organization ID. Required for cookie auth. Not needed for API key auth (org resolved from key).
uuidSpace ID. Required for space-scoped routes (agents, runs, schedules, and space-scoped module routes). Not needed for API key auth (space resolved from key).
curl -X GET "https://your-instance/api/end-users"{
"object": "list",
"data": [
{
"id": "eu_cm4jkl012",
"object": "end_user",
"spaceId": "spc_2c5d8f1a-4b70-4e63-9d18-3a7f5c9e0b24",
"name": "Alice Martin",
"email": "[email protected]",
"externalId": "usr_12345",
"metadata": {
"plan": "pro"
},
"createdAt": "2026-01-15T10:30:00Z",
"updatedAt": "2026-01-15T10:30:00Z"
}
],
"hasMore": false,
"limit": 20
}{
"type": "https://docs.appstrate.dev/errors/validation-failed",
"title": "Validation Failed",
"status": 400,
"detail": "name: Invalid input: expected string, received undefined (+2 more)",
"code": "validation_failed",
"request_id": "req_abc123",
"errors": [
{
"field": "name",
"code": "required",
"message": "Invalid input: expected string, received undefined"
},
{
"field": "email",
"code": "invalid_format",
"message": "Invalid email address"
},
{
"field": "age",
"code": "invalid_type",
"message": "Invalid input: expected number, received string"
}
]
}{
"type": "https://docs.appstrate.dev/errors/unauthorized",
"title": "Unauthorized",
"status": 401,
"detail": "Invalid or missing session",
"code": "unauthorized",
"request_id": "req_abc123"
}{
"type": "https://docs.appstrate.dev/errors/forbidden",
"title": "Forbidden",
"status": 403,
"detail": "Insufficient permissions",
"code": "forbidden",
"request_id": "req_abc123"
}{
"type": "https://docs.appstrate.dev/errors/rate-limited",
"title": "Rate Limited",
"status": 429,
"detail": "Too many requests. Please try again shortly.",
"code": "rate_limited",
"request_id": "req_abc123",
"retry_after": 30
}