Teams

Get a list of teams.

GEThttps://api.usepylon.com/teams

Response

200400404500

Body

application/json

dataarray of Team (object)

The data payload of the response.

paginationPagination (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

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

Response

200400404500

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "users": [
        {
          "id": "text"
        }
      ]
    }
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": false
  },
  "request_id": "text"
}

Get a team by its ID.

GEThttps://api.usepylon.com/teams/{id}

Path parameters

id*string

The ID of the team to fetch.

Response

200400404500

Body

application/json

dataTeam (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

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

Response

200400404500

{
  "data": {
    "id": "text",
    "name": "text",
    "users": [
      {
        "id": "text"
      }
    ]
  },
  "request_id": "text"
}

Update an existing team.

PATCHhttps://api.usepylon.com/teams/{id}

Path parameters

id*string

The ID of the team to update.

Body

application/json

namestring

The name of the team.

user_idsarray of string

The list of user IDs to add to the team. If provided, the team members will be updated to be exactly the given users.

Response

200400404500

Body

application/json

dataTeam (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

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

Response

200400404500

{
  "data": {
    "id": "text",
    "name": "text",
    "users": [
      {
        "id": "text"
      }
    ]
  },
  "request_id": "text"
}

Create a new team.

POSThttps://api.usepylon.com/teams

Body

application/json

namestring

The name of the team.

user_idsarray of string

The list of user IDs to add to the team.

Response

200400404500

Body

application/json

dataTeam (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

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

Response

200400404500

{
  "data": {
    "id": "text",
    "name": "text",
    "users": [
      {
        "id": "text"
      }
    ]
  },
  "request_id": "text"
}