agentlyleads docs
Team API

API Reference

The reference below covers the Team API endpoint. Code examples are generated automatically; the live playground is disabled to prevent accidental writes to production from the docs site.

GET/api/v1/team

Authorization

BearerAuth
AuthorizationBearer <token>

Pass an API key issued from the agentlyleads workspace settings. Example: Authorization: Bearer alk_live_xxxxxxxxxxxx

In: header

Query Parameters

active?string

Only active (true) or only deactivated (false) users. Omit for all.

Value in

  • "true"
  • "false"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/team"
{  "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"    }  ]}
{  "error": "active must be true or false."}
{  "error": "Invalid or missing API key."}
{  "error": "API key missing required scope: read:team."}
{  "error": "Rate limit exceeded."}