Teams

Get a team

GET/api/teams/{teamId}

Returns the specified team's details, including its members.

Headers

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

Path parameters

Name	Type	Description
teamIdrequired	string	ID of the associated team.

Responses

200The operation completed successfully.

Name	Type	Description
accessCoderequired	string	Code used to join the team.
createdAtrequired	string	Date and time the record was created.
deletedAtrequired	string	Date and time the record was deleted, if applicable.
idrequired	string	Unique identifier of the resource.
logoUrlrequired	string	URL of the logo image.
namerequired	string	Display name of the resource.
twoFactorRequiredrequired	boolean	Whether two-factor authentication is required.
updatedAtrequired	string	Date and time the record was last updated.

200 example

{
  "accessCode": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "id": "string",
  "logoUrl": "string",
  "name": "string",
  "twoFactorRequired": true,
  "updatedAt": "2024-01-15T09:30:00Z"
}

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 GET 'https://api.example.com/api/teams/{teamId}' \
  -H 'Authorization: Bearer <token>'

PreviousDelete a team NextGet a team member