List Users on Team

get

https://api.lucid.co/v1/teams/{id}/users

Retrieves basic information about users on a specified team. With user permissions, the authenticated user must have access to the team. With admin permissions, users from any team belonging to the account can be retrieved.

This endpoint is paginated.

Retrieves basic information about the users on a given team, provided the authenticated user has at least read-only access to that team. Information about users on additional teams may be retrieved by using admin permissions (see below).

📘
The list of users returned depends on whether the request was made using user or admin permissions.

User: team must be one that the requesting user has access to

Must request with a user grant/scope and either omit the header Lucid-Request-As or contain the value user.

Admin: team must belong to the account

Must request with an admin grant/scope and contain the header Lucid-Request-As with value admin.

📘
This endpoint is paginated. For more information, see Pagination.

Valid Authentication Methods

API Key Grants:

TeamsReadonly
TeamsAdmin

OAuth 2.0 User Token Scopes:

teams:readonly
teams:admin

Responses

403

Forbidden. if the user making the request does not have access to the specified team. if the team has been archived, is not directly accessible by the authenticated user, or does not exist.

The list of users returned depends on whether the request was made using user or admin permissions.

This endpoint is paginated. For more information, see Pagination.

Valid Authentication Methods

API Key Grants:

OAuth 2.0 User Token Scopes:

200OK. Returns a list of Profile resources containing basic information about users on the specified team. If requesting as admin, Profile resources may be returned even if the authenticated user does not have direct access to the specified team.