v1

latestOpenAPI 3.0.3Lucid2026-07-14155181312.3 KB
Teams

Create Team

Creates a new team for the authenticated user, populated with the given team members. Hidden teams cannot be created via the REST API.

Whether the requesting user is automatically added to the team depends on the permission type. With user permissions, the user is automatically added to the team. With admin permissions, the user is not automatically added.

post/v1/teams

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.

Request body

namestring required

The team's name. Max length of name is 80 characters.

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

The type of the team

usersinteger[] required

Array of IDs of users to be on the team.

Example request

{
  "name": "Team Name",
  "type": "open",
  "users": [
    321,
    654,
    987
  ]
}

Response

Created. Returns a Team resource containing information about the created team. If requesting as admin, the user making the request will not have been automatically included as a user on the 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"
}