Documentation Index
Fetch the complete documentation index at: https://docs.askassembly.app/llms.txt
Use this file to discover all available pages before exploring further.
Users
List and look up workspace members via the external API.
Authentication
All endpoints require an Authorization header with a valid org API key:
Authorization: <your_org_api_key>
Endpoints
List users (paginated)
GET /list-users?page=<n>&page_size=<n>
Query parameters
page (optional, integer, default: 0) — Zero‑based page index.page_size (optional, integer, default: 10, max: 100) — Number of users to return per page.
Response
{
"users": [
{
"id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"email": "alice@example.com",
"username": "alice",
"first_name": "Alice",
"last_name": "Smith",
"picture_url": "https://example.com/alice.jpg",
"user_role": "Admin",
"calendar_link": "https://calendly.com/alice"
},
{
"id": "f0e9d8c7-b6a5-4321-fedc-ba9876543210",
"email": "bob@example.com",
"username": "bob",
"first_name": "Bob",
"last_name": "Jones",
"picture_url": "https://example.com/bob.jpg",
"user_role": "Member",
"calendar_link": null
}
],
"page": 0,
"page_size": 10,
"has_more": true
}
Get a single user by ID
GET /fetch-user?id=<user_id>
Response
{
"user": {
"id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"email": "alice@example.com",
"username": "alice",
"first_name": "Alice",
"last_name": "Smith",
"picture_url": "https://example.com/alice.jpg",
"user_role": "Admin",
"calendar_link": "https://calendly.com/alice"
}
}
Get a single user by email
GET /fetch-user?email=<email>
Response
{
"user": {
"id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"email": "alice@example.com",
"username": "alice",
"first_name": "Alice",
"last_name": "Smith",
"picture_url": "https://example.com/alice.jpg",
"user_role": "Admin",
"calendar_link": "https://calendly.com/alice"
}
}
Errors
400 Bad Request if:
- Neither
id nor email is provided.
- Both
id and email are provided.
- The user ID or email is not found in your workspace.
401 Unauthorized if the API key is missing or invalid.
