For the complete documentation index, see llms.txt. This page is also available as Markdown.

Teams

Get a list of teams

get
/teams

Returns all teams for the organization, each with how it assigns issues and its recurring assignment schedule if it has one.

Rate limit: 300 requests per minute

Authorizations
AuthorizationstringRequired

Authorization: Bearer

Responses
200Success
application/json
request_idstringOptional

The request ID for tracking.

get/teams
GET /teams HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "data": [
    {
      "assignment_configuration": {
        "assignment_method": "text",
        "only_assign_if_user_active": true,
        "override_existing_assignee": true,
        "team_schedule_id": "text"
      },
      "id": "text",
      "name": "text",
      "schedule": {
        "blocks": [
          {
            "days": [
              "text"
            ],
            "end_time": "text",
            "recurrence": "text",
            "start_time": "text",
            "team_id": "text",
            "user_id": "text",
            "week_offset": 1
          }
        ],
        "id": "text",
        "support_hours_id": "text",
        "timezone": "text"
      },
      "users": [
        {
          "email": "text",
          "id": "text"
        }
      ]
    }
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": true
  },
  "request_id": "text"
}

Get a team by its ID

get
/teams/{id}

Returns a single team by ID, with how it assigns issues and its recurring assignment schedule if it has one.

Rate limit: 300 requests per minute

Authorizations
AuthorizationstringRequired

Authorization: Bearer

Path parameters
idstringRequired

The ID of the team to fetch.

Responses
200Success
application/json
request_idstringOptional

The request ID for tracking.

get/teams/{id}
GET /teams/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "data": {
    "assignment_configuration": {
      "assignment_method": "text",
      "only_assign_if_user_active": true,
      "override_existing_assignee": true,
      "team_schedule_id": "text"
    },
    "id": "text",
    "name": "text",
    "schedule": {
      "blocks": [
        {
          "days": [
            "text"
          ],
          "end_time": "text",
          "recurrence": "text",
          "start_time": "text",
          "team_id": "text",
          "user_id": "text",
          "week_offset": 1
        }
      ],
      "id": "text",
      "support_hours_id": "text",
      "timezone": "text"
    },
    "users": [
      {
        "email": "text",
        "id": "text"
      }
    ]
  },
  "request_id": "text"
}

Update an existing team

patch
/teams/{id}

Updates an existing team, including how it assigns issues and its recurring assignment schedule. Only provided fields are modified; supplying schedule.blocks replaces the whole rotation, and omitting it leaves the rotation unchanged.

Rate limit: 120 requests per minute

Authorizations
AuthorizationstringRequired

Authorization: Bearer

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
200Success
application/json
request_idstringOptional

The request ID for tracking.

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

{
  "assignment_configuration": {
    "assignment_method": "routing",
    "only_assign_if_user_active": true,
    "override_existing_assignee": true
  },
  "name": "text",
  "schedule": {
    "blocks": [
      {
        "days": [
          "text"
        ],
        "end_time": "17:00",
        "recurrence": "weekly",
        "start_time": "09:00",
        "team_id": "text",
        "user_id": "text",
        "week_offset": 1
      }
    ],
    "support_hours_id": "text",
    "timezone": "America/New_York"
  },
  "user_ids": [
    "text"
  ]
}
{
  "data": {
    "assignment_configuration": {
      "assignment_method": "text",
      "only_assign_if_user_active": true,
      "override_existing_assignee": true,
      "team_schedule_id": "text"
    },
    "id": "text",
    "name": "text",
    "schedule": {
      "blocks": [
        {
          "days": [
            "text"
          ],
          "end_time": "text",
          "recurrence": "text",
          "start_time": "text",
          "team_id": "text",
          "user_id": "text",
          "week_offset": 1
        }
      ],
      "id": "text",
      "support_hours_id": "text",
      "timezone": "text"
    },
    "users": [
      {
        "email": "text",
        "id": "text"
      }
    ]
  },
  "request_id": "text"
}

Create a new team

post
/teams

Creates a new team with a name and optional member list. Optionally sets how the team assigns issues and creates its recurring assignment schedule in the same call.

Rate limit: 30 requests per minute

Authorizations
AuthorizationstringRequired

Authorization: Bearer

Body
namestringRequired

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.

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

{
  "assignment_configuration": {
    "assignment_method": "routing",
    "only_assign_if_user_active": true,
    "override_existing_assignee": true
  },
  "name": "text",
  "schedule": {
    "blocks": [
      {
        "days": [
          "text"
        ],
        "end_time": "17:00",
        "recurrence": "weekly",
        "start_time": "09:00",
        "team_id": "text",
        "user_id": "text",
        "week_offset": 1
      }
    ],
    "support_hours_id": "text",
    "timezone": "America/New_York"
  },
  "user_ids": [
    "text"
  ]
}
{
  "data": {
    "assignment_configuration": {
      "assignment_method": "text",
      "only_assign_if_user_active": true,
      "override_existing_assignee": true,
      "team_schedule_id": "text"
    },
    "id": "text",
    "name": "text",
    "schedule": {
      "blocks": [
        {
          "days": [
            "text"
          ],
          "end_time": "text",
          "recurrence": "text",
          "start_time": "text",
          "team_id": "text",
          "user_id": "text",
          "week_offset": 1
        }
      ],
      "id": "text",
      "support_hours_id": "text",
      "timezone": "text"
    },
    "users": [
      {
        "email": "text",
        "id": "text"
      }
    ]
  },
  "request_id": "text"
}

Last updated

Was this helpful?