Knowledge Base Website Changelog Book a Demo Login

Teams

PreviousTags NextTicket Forms

Last updated 3 months ago

Was this helpful?

get

Get a list of teams

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.usepylon.com/teams' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

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

get

Get a team by its ID

Authorizations

Path parameters

idstringrequired

The ID of the team to fetch.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.usepylon.com/teams/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

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

patch

Update an existing team

Authorizations

Path parameters

idstringrequired

The ID of the team to update.

Body

namestringoptional

The name of the team.

user_idsstring[]optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.usepylon.com/teams/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "user_ids": [
      "text"
    ]
  }'

200

400

404

500

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

post

Create a new team

Authorizations

Body

namestringoptional

The name of the team.

user_idsstring[]optional

The list of user IDs to add to the team.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.usepylon.com/teams' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "user_ids": [
      "text"
    ]
  }'

200

400

404

500

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