Teams

GET

Retrieves information about the authenticated user's team.

GET/teams

Response

200403404

Team information retrieved successfully

Body

application/json

usersLimitnumber

Example: 5

namestring

Example: "Team Name"

countnumber

Example: 10

Request

JavaScriptCurlPython

const response = await fetch('/teams', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403404

{
  "usersLimit": 5,
  "name": "Team Name",
  "count": 10
}

Retrieves members of the authenticated user's team.

GET/teams/members

Response

200403

Team members retrieved successfully

Body

application/json

idnumber

Example: 1

firstNamestring

Example: "John"

lastNamestring

Example: "Doe"

phonestring

Example: "123-456-7890"

rolestring

Example: "Member"

isActiveboolean

Example: true

invitationAcceptedboolean

Example: true

Request

JavaScriptCurlPython

const response = await fetch('/teams/members', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403

[
  {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "phone": "123-456-7890",
    "role": "Member",
    "isActive": true,
    "invitationAccepted": true
  }
]

Retrieves available team roles.

GET/teams/roles

Response

200

Team roles retrieved successfully

Body

application/json

labelstring

Example: "Member"

valuestring

Example: "Member"

Request

JavaScriptCurlPython

const response = await fetch('/teams/roles', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "label": "Member",
    "value": "Member"
  }
]

Checks the team limit for the authenticated user.

GET/teams/limit

Response

200500

Team limit checked successfully

Body

application/json

boolean

Example: true

Request

JavaScriptCurlPython

const response = await fetch('/teams/limit', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

true

Retrieves all teams based on the provided parameters.

GET/teams/all

Query parameters

Response

200500

Teams retrieved successfully

Body

application/json

idstring

Example: "team_id"

namestring

Example: "Team Name"

usersLimitnumber

Example: 5

membersCountnumber

Example: 10

ownerobject

subscriptionstring

Example: "Basic"

isImpersonationEnabledboolean

Example: true

Request

JavaScriptCurlPython

const response = await fetch('/teams/all', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

[
  {
    "id": "team_id",
    "name": "Team Name",
    "usersLimit": 5,
    "membersCount": 10,
    "owner": {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe",
      "email": "[e-mail]"
    },
    "subscription": "Basic",
    "isImpersonationEnabled": true
  }
]

POST

Creates a new team.

POST/teams

Body

application/json

Team creation data

teamNamestring

Example: "Team Name"

Response

201400500

Team created successfully

Body

application/json

idstring

Example: "team_id"

namestring

Example: "Team Name"

usersLimitnumber

Example: 5

Request

JavaScriptCurlPython

const response = await fetch('/teams', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400500

{
  "id": "team_id",
  "name": "Team Name",
  "usersLimit": 5
}

Creates an invitation to join the team.

POST/teams/invitation

Body

application/json

Invitation data

email*string

Email of the invitee

Example: "[e-mail]"

firstName*nullable string

First name of the invitee

Example: "John"

lastName*nullable string

Last name of the invitee

Example: "Doe"

phone*nullable string

Phone number of the invitee

Example: "123-456-7890"

role*enum

Role of the invitee in the team

Example: "Viewer"

OwnerManagerViewer

teamId*nullable string

Team ID for the invitation

Example: "team_id"

Response

200400403500

Invitation created successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/teams/invitation', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "[e-mail]",
      "firstName": "John",
      "lastName": "Doe",
      "phone": "123-456-7890",
      "role": "Viewer",
      "teamId": "team_id"
    }),
});
const data = await response.json();

Response

200400403500

{
  "message": "Invitation email sent",
  "description": "<p>Wait for the invited person to finish their registration.</p>",
  "__$markdownParsed": true
}

PUT

Leaves a team by its ID. Sends an email to the new owner if provided. Also applies new owners subscription plan to this team.

PUT/teams/leave-team/{id}

Path parameters

id*string

The ID of the team to leave.

Example: "team_id"

Body

application/json

New owner ID data. If provided, an email will be sent to the new owner.

newOwnerIdnumber

Example: 1

Response

200400500

Left the team successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/teams/leave-team/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400500

{
  "message": "Left the team successfully",
  "description": "<p>You have left the team successfully.</p>",
  "__$markdownParsed": true
}

Accepts an invitation to join a team.

PUT/teams/accept-invitation/{id}

Path parameters

id*string

The ID of the team to accept the invitation for.

Example: "team_id"

Response

200400500

Invitation accepted successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/teams/accept-invitation/{id}', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "message": "Invitation accepted successfully",
  "description": "<p>You have accepted the invitation successfully.</p>",
  "__$markdownParsed": true
}

Declines an invitation to join a team.

PUT/teams/decline-invitation/{id}

Path parameters

id*string

The ID of the team to decline the invitation for.

Example: "team_id"

Response

200400500

Invitation declined successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/teams/decline-invitation/{id}', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "message": "Invitation declined successfully",
  "description": "<p>You have declined the invitation successfully.</p>",
  "__$markdownParsed": true
}

DELETE

Cancels an invitation to join the team.

DELETE/teams/invitation/{id}

Path parameters

id*number

The ID of the user to cancel the invitation for.

Example: 1

Body

application/json

Membership ID data

membershipIdnumber

Example: 1

Response

200400500

Invitation cancelled successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/teams/invitation/{id}', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400500

{
  "message": "Invitation cancelled successfully",
  "description": "<p>The invitation has been cancelled successfully.</p>",
  "__$markdownParsed": true
}

Deletes a team by its ID.

DELETE/teams/{id}

Path parameters

id*string

The ID of the team to delete.

Example: "team_id"

Response

200400403500

Team deleted successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/teams/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400403500

{
  "message": "Team deleted successfully",
  "description": "<p>The team has been deleted successfully.</p>",
  "__$markdownParsed": true
}