Teams

Get a list of teams

get

Returns all teams for the organization.

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400Error

application/json

404Error

application/json

500Error

application/json

get

/teams

HTTPcURLJavaScriptPython

GET /teams HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Get a team by its ID

get

Returns a single team by ID.

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the team to fetch.

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400Error

application/json

404Error

application/json

500Error

application/json

get

/teams/{id}

HTTPcURLJavaScriptPython

GET /teams/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Update an existing team

patch

Updates an existing team. Only provided fields are modified.

Rate limit: 20 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the team to update.

Body

application/json

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

200Success

application/json

request_idstringOptional

The request ID for tracking.

400Error

application/json

404Error

application/json

500Error

application/json

patch

/teams/{id}

HTTPcURLJavaScriptPython

PATCH /teams/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "name": "text",
  "user_ids": [
    "text"
  ]
}

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

Create a new team

post

Creates a new team with a name and optional member list.

Rate limit: 10 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Body

application/json

namestringOptional

The name of the team.

user_idsstring[]Optional

The list of user IDs to add to the team.

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400Error

application/json

404Error

application/json

500Error

application/json

post

/teams

HTTPcURLJavaScriptPython

POST /teams HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "name": "text",
  "user_ids": [
    "text"
  ]
}

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