Teams

GET

Retrieves information about the authenticated user's team.

get

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/teams'

200

403

404

200

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

Team information retrieved successfully

Retrieves members of the authenticated user's team.

get

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/teams/members'

200

403

200

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

Team members retrieved successfully

Retrieves available team roles.

get

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/teams/roles'

200

200

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

Team roles retrieved successfully

Checks the team limit for the authenticated user.

get

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/teams/limit'

200

500

200

true

Team limit checked successfully

Retrieves all teams based on the provided parameters.

get

Query parameters

offsetnumberoptional

The number of records to skip.

Example: 0

limitnumberoptional

The maximum number of records to return.

Example: 10

globalSearchstringoptional

The global search term to use for finding teams.

Example: Team Name

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/teams/all'

200

500

200

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

Teams retrieved successfully

POST

Creates a new team.

post

Body

teamNamestringoptional

Example: Team Name

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/teams' \
  --header 'Content-Type: application/json' \
  --data '{
    "teamName": "Team Name"
  }'

201

400

500

201

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

Team created successfully

Creates an invitation to join the team.

post

Body

emailstringrequired

Example: [e-mail]

firstNamestring | nullablerequired

Example: John

lastNamestring | nullablerequired

Example: Doe

phonestring | nullablerequired

Example: 123-456-7890

rolestring · enumrequired

Example: Viewer

Available options:

teamIdstring | nullablerequired

Example: team_id

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/teams/invitation' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "[e-mail]",
    "firstName": "John",
    "lastName": "Doe",
    "phone": "123-456-7890",
    "role": "Viewer",
    "teamId": "team_id"
  }'

200

400

403

500

200

{
  "message": "Invitation email sent",
  "description": "Wait for the invited person to finish their registration."
}

Invitation created successfully

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

Path parameters

idstringrequired

The ID of the team to leave.

Example: team_id

Body

newOwnerIdnumberoptional

Example: 1

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/teams/leave-team/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "newOwnerId": 1
  }'

200

400

500

200

{
  "message": "Left the team successfully",
  "description": "You have left the team successfully."
}

Left the team successfully

Accepts an invitation to join a team.

put

Path parameters

idstringrequired

The ID of the team to accept the invitation for.

Example: team_id

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/teams/accept-invitation/{id}'

200

400

500

200

{
  "message": "Invitation accepted successfully",
  "description": "You have accepted the invitation successfully."
}

Invitation accepted successfully

Declines an invitation to join a team.

put

Path parameters

idstringrequired

The ID of the team to decline the invitation for.

Example: team_id

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/teams/decline-invitation/{id}'

200

400

500

200

{
  "message": "Invitation declined successfully",
  "description": "You have declined the invitation successfully."
}

Invitation declined successfully

DELETE

Cancels an invitation to join the team.

delete

Path parameters

idnumberrequired

The ID of the user to cancel the invitation for.

Example: 1

Body

membershipIdnumberoptional

Example: 1

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/teams/invitation/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "membershipId": 1
  }'

200

400

500

200

{
  "message": "Invitation cancelled successfully",
  "description": "The invitation has been cancelled successfully."
}

Invitation cancelled successfully

Deletes a team by its ID.

delete

Path parameters

idstringrequired

The ID of the team to delete.

Example: team_id

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/teams/{id}'

200

400

403

500

200

{
  "message": "Team deleted successfully",
  "description": "The team has been deleted successfully."
}

Team deleted successfully