List team members
AI agents: read /llms.txt; add .md to any page URL. This page as Markdown: /reference/team-members/v1-user-index.md. Index of every page and the rules for every call: /llms.txt. Guides and concepts in one file: /llms-full.txt. OpenAPI: /openapi.json.
GET/
Returns everyone on the team: name, email, permission group (roles), whether they are the owner, and when they last signed in.
Use the id wherever a request asks for a user, for example to assign people to a job, task or sales order. People who were invited but haven't joined yet are in the invitations list instead.
Path parameters
Your team slug, shown as Team ID next to your API key in Profile.
- Example
your-team
- Example
Request body
This operation takes no request body.
Response
200Successful response.
Fields of each item (8)
True for the team owner. There is exactly one.
Null when they never signed in.
Their permission group on this team.
Errors
401The API key is missing or wrong (
unauthenticated).403You are not allowed to do this.
api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only{"message": "Insufficient Permission"}. Other refusals use the error envelope, withunauthorizedoruser_is_not_authorized.404Not found.
page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's.code: null, with a message that starts "No query results for": there is no record with that id.
Related
- GETList invitations
/v1/ api/ store/ {team_slug}/ setting/ invite - GETGet a team member
/v1/ api/ store/ {team_slug}/ setting/ user/ {hash_id} - GETList permission groups
/v1/ api/ store/ {team_slug}/ setting/ group
