v1

latestOpenAPI 3.0.3Lucid2026-07-14155181312.3 KB
Teams

List 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.

get/v1/teams

Query parameters

filter'include=memberonly'

The filter to apply to the returned teams. The only supported filter is "include=memberonly", which returns only teams that the requesting user is a member of. If no filter is provided, all open and closed teams on the account are returned, along with hidden teams that the requesting user is a member of.

Headers

Lucid-Request-Asstring

If the requesting user is an account owner, team admin, or team manager with the required permissions and they make the request with the value of “admin” as this header and include an admin scope, the request will be made using their admin permissions.

Response

OK. 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.

idnumber

The unique ID for the team.

namestring

The team's name.

type'hidden' | 'closed' | 'open'

The type of the team

createdstring date-time

Date and time when the team was created.

archivedstring date-time nullable

Date and time when the team was archived (if it has been archived).

Example response

[
  {
    "id": 123456789,
    "name": "Team Name",
    "type": "open",
    "created": "2024-01-30T16:29:37Z"
  }
]