Teams

Get Team

Retrieves information about a requested team. The response depends on the permission type used: user permissions require that the authenticated user has access to the team, while admin permissions allow access to any team belonging to the account.

get/v1/teams/{id}

Path parameters

idnumber required

ID of the team to get.

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 Team resource containing information about the specified team. If requesting as admin, a Team resource may be returned even if the authenticated user does not have direct access to the specified team.

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"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.