Team API
GET /api/v1/team
Returns every user in the workspace, oldest first. Requires the read:team scope (or * for full access).
Use it to map your own user records to agentlyleads user IDs, or to find a manager before assigning work. The Team API is read-only: invites, role changes and deactivation stay in the app, where an owner is signed in.
Request
GET /api/v1/team?active=true HTTP/1.1
Host: agentlyleads.com
Authorization: Bearer alk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxQuery parameters
| Parameter | Required | Description |
|---|---|---|
active | No | true for active users only, false for deactivated users only. Omit for everyone |
Response: 200
{
"users": [
{
"id": "cmq1user0alk34567890",
"name": "Dana Ortiz",
"email": "dana@example.com",
"role": "OWNER",
"active": true,
"manager": null,
"createdAt": "2026-06-01T10:00:00.000Z"
},
{
"id": "cmq1user1alk34567891",
"name": "Sam Lee",
"email": "sam@example.com",
"role": "MEMBER",
"active": true,
"manager": { "id": "cmq1user0alk34567890", "name": "Dana Ortiz" },
"createdAt": "2026-07-12T09:30:00.000Z"
}
]
}| Field | Type | Notes |
|---|---|---|
id | string | The user ID |
name | string | Display name |
email | string | Login email |
role | string | OWNER or MEMBER |
active | boolean | false once an owner deactivates the user |
manager | object or null | { id, name } of the person they report to |
createdAt | string (ISO 8601) | When the user joined |
Password hashes, sessions and tokens are never returned.
Errors
| Status | When |
|---|---|
400 | active is something other than true or false |
401 | Missing, invalid, expired or revoked API key |
403 | The key lacks read:team |
429 | Rate limit exceeded (120 requests per minute per key) |