List Teams

get

https://api.lucid.co/v1/teams

Retrieves information about teams the authenticated user has at least read-only access to.

The list of teams returned depends on whether the request was made using user or admin permissions. User permissions return teams the requesting user has access to. Admin permissions return all teams belonging to the account.

This endpoint is paginated.

Retrieves information about teams the authenticated user has at least read-only access to. Additional teams may be retrieved by using admin permissions (see below).

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

User: teams the requesting user has access to and matching search parameters

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

Admin: teams belonging to the account and matching search parameters

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 and Account Token Scopes:

teams:readonly
teams:admin

Response

The list of teams 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 and Account Token Scopes:

200OK. Returns a list of Team resources containing information about teams directly accessible to the authenticated user. If requesting as admin, the list includes all teams on the account. If a filter is specified, only teams matching the filter are returned.