Teams

Join a team

POST/api/teams/join

Adds the current user to a team as a member using the team's access code.

Headers

Name	Type	Description
Authorizationrequired	string	Authentication credentials, e.g. `Bearer <token>`.

Request body

Name	Type	Description
accessCoderequired	string	Code used to join the team.

Example request

{
  "accessCode": "string"
}

Responses

200The operation completed successfully.

Name	Type	Description
createdAtrequired	string	Date and time the record was created.
idrequired	string	Unique identifier of the resource.
rolerequired	string	Permission role assigned to the user.
teamIdrequired	string	ID of the associated team.
updatedAtrequired	string	Date and time the record was last updated.
userIdrequired	string	ID of the associated user.

200 example

{
  "createdAt": "2024-01-15T09:30:00Z",
  "id": "string",
  "role": "string",
  "teamId": "string",
  "updatedAt": "2024-01-15T09:30:00Z",
  "userId": "string"
}

400Bad request.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

404Not found.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

404 example

{
  "error": {
    "code": "not-found",
    "message": "Not found.",
    "status": 404
  }
}

Code samples

cURL

curl -X POST 'https://api.example.com/api/teams/join' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "accessCode": "string"
}'

PreviousGet a team member NextList a team's boards