Teams | Pylon

get

Get a list of teams

Authorizations

Responses

application/json

objectOptional

application/json

get

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

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "users": [
        {
          "email": "text",
          "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

objectOptional

application/json

get

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

{
  "data": {
    "id": "text",
    "name": "text",
    "users": [
      {
        "email": "text",
        "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

objectOptional

application/json

patch

PATCH /teams/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer JWT
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"
}

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

objectOptional

application/json

post

POST /teams HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer JWT
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"
}