Team API | Uptizm

GET /team/members team:read #

List team members

The members of the key's team with their roles.

Response 200 application/json

data array of TeamMemberResource required
- id string required
- name string required
- email string or null required
- role string required

Errors

401 Unauthenticated
403 The key lacks the ability this endpoint requires (required_ability names it), or the action is not allowed for the team.
429 Rate limited. Each key may make 120 reads (GET) and 30 writes per minute; wait for Retry-After seconds.

Code samples

curl -X GET "https://api.uptizm.com/v1/team/members" \
  -H "Authorization: Bearer $UPTIZM_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.uptizm.com/v1/team/members', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.UPTIZM_API_KEY}`,
    'Accept': 'application/json',
  },
});

const data = await response.json();

<?php

$curl = curl_init('https://api.uptizm.com/v1/team/members');

curl_setopt_array($curl, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.getenv('UPTIZM_API_KEY'),
        'Accept: application/json',
    ],
]);

$response = curl_exec($curl);

import os

import requests

response = requests.get(
    "https://api.uptizm.com/v1/team/members",
    headers={
        "Authorization": "Bearer " + os.environ["UPTIZM_API_KEY"],
        "Accept": "application/json",
    },
)

print(response.json())

Try it

API key

ms

PUT /team/members/{user} team:manage #

Change a member's role

Changes a member's role. A key can never grant admin.

Parameters

Name	In	Type	Required	Description
user	path	string	Yes

Request body application/json

role string, one of "admin", "editor", "member" required

Response 200 application/json

data TeamMemberResource required
- id string required
- name string required
- email string or null required
- role string required

Errors

401 Unauthenticated
403 The key lacks the ability this endpoint requires (required_ability names it), or the action is not allowed for the team.
422 Validation error
429 Rate limited. Each key may make 120 reads (GET) and 30 writes per minute; wait for Retry-After seconds.

Code samples

curl -X PUT "https://api.uptizm.com/v1/team/members/USER" \
  -H "Authorization: Bearer $UPTIZM_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "role": "admin"
}'

const payload = {
    "role": "admin"
};

const response = await fetch('https://api.uptizm.com/v1/team/members/USER', {
  method: 'PUT',
  headers: {
    'Authorization': `Bearer ${process.env.UPTIZM_API_KEY}`,
    'Accept': 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(payload),
});

const data = await response.json();

<?php

$curl = curl_init('https://api.uptizm.com/v1/team/members/USER');

$payload = <<<'JSON'
{
    "role": "admin"
}
JSON;

curl_setopt_array($curl, [
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.getenv('UPTIZM_API_KEY'),
        'Accept: application/json',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => $payload,
]);

$response = curl_exec($curl);

import os

import requests

response = requests.put(
    "https://api.uptizm.com/v1/team/members/USER",
    headers={
        "Authorization": "Bearer " + os.environ["UPTIZM_API_KEY"],
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    data=r'''{
    "role": "admin"
}''',
)

print(response.json())

Try it

API key user path, string, required Request body This runs against my live workspace

ms

DELETE /team/members/{user} team:manage #

Remove a team member

Removes a member from the team.

Parameters

Name	In	Type	Required	Description
user	path	string	Yes

Response 204

No body.

Errors

401 Unauthenticated
403 The key lacks the ability this endpoint requires (required_ability names it), or the action is not allowed for the team.
422 Validation error
429 Rate limited. Each key may make 120 reads (GET) and 30 writes per minute; wait for Retry-After seconds.

Code samples

curl -X DELETE "https://api.uptizm.com/v1/team/members/USER" \
  -H "Authorization: Bearer $UPTIZM_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.uptizm.com/v1/team/members/USER', {
  method: 'DELETE',
  headers: {
    'Authorization': `Bearer ${process.env.UPTIZM_API_KEY}`,
    'Accept': 'application/json',
  },
});

console.log(response.status);

<?php

$curl = curl_init('https://api.uptizm.com/v1/team/members/USER');

curl_setopt_array($curl, [
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.getenv('UPTIZM_API_KEY'),
        'Accept: application/json',
    ],
]);

$response = curl_exec($curl);

import os

import requests

response = requests.delete(
    "https://api.uptizm.com/v1/team/members/USER",
    headers={
        "Authorization": "Bearer " + os.environ["UPTIZM_API_KEY"],
        "Accept": "application/json",
    },
)

print(response.status_code)

Try it

API key user path, string, required This runs against my live workspace

ms

GET /team/invitations team:read #

List pending invitations

The team's pending invitations.

Response 200 application/json

data array of string required

Errors

401 Unauthenticated
403 The key lacks the ability this endpoint requires (required_ability names it), or the action is not allowed for the team.
429 Rate limited. Each key may make 120 reads (GET) and 30 writes per minute; wait for Retry-After seconds.

Code samples

curl -X GET "https://api.uptizm.com/v1/team/invitations" \
  -H "Authorization: Bearer $UPTIZM_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.uptizm.com/v1/team/invitations', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.UPTIZM_API_KEY}`,
    'Accept': 'application/json',
  },
});

const data = await response.json();

<?php

$curl = curl_init('https://api.uptizm.com/v1/team/invitations');

curl_setopt_array($curl, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.getenv('UPTIZM_API_KEY'),
        'Accept: application/json',
    ],
]);

$response = curl_exec($curl);

import os

import requests

response = requests.get(
    "https://api.uptizm.com/v1/team/invitations",
    headers={
        "Authorization": "Bearer " + os.environ["UPTIZM_API_KEY"],
        "Accept": "application/json",
    },
)

print(response.json())

Try it

API key

ms

POST /team/invitations team:manage #

Invite a member

Invites an email address to the team. A key can never invite with role admin.

Parameters

Name	In	Type	Required	Description
Idempotency-Key	header	string	No	Any unique string per logical request.

Request body application/json

email string, email, max length 255 required
role string, one of "admin", "editor", "member" required

Response 201 application/json

data JsonResource required

Errors

401 Unauthenticated
403 The key lacks the ability this endpoint requires (required_ability names it), or the action is not allowed for the team.
422 Validation error
429 Rate limited. Each key may make 120 reads (GET) and 30 writes per minute; wait for Retry-After seconds.

Code samples

curl -X POST "https://api.uptizm.com/v1/team/invitations" \
  -H "Authorization: Bearer $UPTIZM_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "email": "string",
    "role": "admin"
}'

const payload = {
    "email": "string",
    "role": "admin"
};

const response = await fetch('https://api.uptizm.com/v1/team/invitations', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.UPTIZM_API_KEY}`,
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify(payload),
});

const data = await response.json();

<?php

$curl = curl_init('https://api.uptizm.com/v1/team/invitations');

$payload = <<<'JSON'
{
    "email": "string",
    "role": "admin"
}
JSON;

curl_setopt_array($curl, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.getenv('UPTIZM_API_KEY'),
        'Accept: application/json',
        'Content-Type: application/json',
        'Idempotency-Key: '.uniqid('', true),
    ],
    CURLOPT_POSTFIELDS => $payload,
]);

$response = curl_exec($curl);

import os
import uuid

import requests

response = requests.post(
    "https://api.uptizm.com/v1/team/invitations",
    headers={
        "Authorization": "Bearer " + os.environ["UPTIZM_API_KEY"],
        "Accept": "application/json",
        "Content-Type": "application/json",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    data=r'''{
    "email": "string",
    "role": "admin"
}''',
)

print(response.json())

Try it

API key Idempotency-Key header, string Request body This runs against my live workspace

ms

DELETE /team/invitations/{invitation} team:manage #

Cancel an invitation

Cancels a pending invitation.

Parameters

Name	In	Type	Required	Description
invitation	path	string	Yes

Response 204

No body.

Errors

401 Unauthenticated
403 The key lacks the ability this endpoint requires (required_ability names it), or the action is not allowed for the team.
429 Rate limited. Each key may make 120 reads (GET) and 30 writes per minute; wait for Retry-After seconds.

Code samples

curl -X DELETE "https://api.uptizm.com/v1/team/invitations/INVITATION" \
  -H "Authorization: Bearer $UPTIZM_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.uptizm.com/v1/team/invitations/INVITATION', {
  method: 'DELETE',
  headers: {
    'Authorization': `Bearer ${process.env.UPTIZM_API_KEY}`,
    'Accept': 'application/json',
  },
});

console.log(response.status);

<?php

$curl = curl_init('https://api.uptizm.com/v1/team/invitations/INVITATION');

curl_setopt_array($curl, [
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.getenv('UPTIZM_API_KEY'),
        'Accept: application/json',
    ],
]);

$response = curl_exec($curl);

import os

import requests

response = requests.delete(
    "https://api.uptizm.com/v1/team/invitations/INVITATION",
    headers={
        "Authorization": "Bearer " + os.environ["UPTIZM_API_KEY"],
        "Accept": "application/json",
    },
)

print(response.status_code)

Try it

API key invitation path, string, required This runs against my live workspace

ms