Team Members API Reference

Retrieve every active user in your workspace.

Overview: This endpoint returns every active user in the workspace your API key belongs to. It is primarily used to look up user IDs before calling write endpoints that require one — for example, assigning a setter, closer, or triager on a lead via PATCH /api/external/leads/:id/assignments.
There is a single endpoint: list all active team members. There is no pagination, no filtering, and no detail/by-ID endpoint — the full set is always returned, ordered alphabetically by name. Deactivated users are excluded.

List Team Members

Returns all active users in your workspace, ordered alphabetically by name. No pagination — the full set is always returned in a single call.

GET/api/external/team-members

Team Member Object Fields

Field	Type	Description
id	string (Clerk user ID)	Unique identifier of the user (e.g. "user_2abc..."). Use this id as setter_id, closer_id, or triager_id when calling PATCH /api/external/leads/:id/assignments.
name	string	The user's full name. May be an empty string if the user has no name set.
email	string	The user's email address.
role	string	The workspace role of the user (e.g. "org:admin", "org:member").

Code Examples

curl -X GET "https://api.hermon.io/api/external/team-members" \
  -H "x-api-key: sk_live_your_key_here"

Response Example

json

{
  "status": "success",
  "message": "Team members fetched successfully",
  "data": [
    {
      "id": "user_2abc123def456",
      "name": "Alex Johnson",
      "email": "alex@acmecoaching.com",
      "role": "org:admin"
    },
    {
      "id": "user_2ghi789jkl012",
      "name": "Sam Carter",
      "email": "sam@acmecoaching.com",
      "role": "org:member"
    }
  ]
}

Usage Pattern

Typical Use Case: The typical use case for this endpoint is a two-step flow:

Fetch all team members to find the id of the user you want to assign.
Update the lead using that id as setter_id, closer_id, or triager_id on the Lead Assignments Update endpoint.

Error Responses

401Missing or invalid API key

json

{
  "status": "error",
  "message": "Invalid or revoked API key"
}

404Resource not found

json

{
  "status": "error",
  "message": "Resource not found"
}

429Rate limit exceeded

json

{
  "status": "error",
  "message": "Rate limit exceeded for this organization. Retry after the number of seconds in the Retry-After header."
}