Pylon
Knowledge BaseWebsiteChangelogBook a DemoLogin
  • Getting Started
    • Introduction
    • Quick Start
    • Slack Setup
    • Channel Configuration
    • User Guide
  • Support Workflows
    • Omnichannel Support
    • Issues
      • Views
      • Statuses
      • Message Editor
      • Copilot
      • Internal Threads
      • Proactive Issues
      • Translation
      • Bulk actions
      • Issue Groups
    • SLAs
    • Support Hours
    • CSAT
    • Ticket Forms
    • Assignment Rules
      • User Status
    • Email
  • Platform
    • Custom Fields
    • Required and Conditional Fields
    • Tags
    • Teams
    • Triggers
      • Logs & History
    • Macros
    • Command Search
    • Roles & User Management
    • Training Data
    • Ask AI
  • AI Agents
    • Overview
    • Build
      • Resources
    • Test
  • Knowledge Base
    • Overview
    • Articles & Collections
      • Editor
      • Copilot
      • Templates
      • Collaboration
    • Knowledge Gaps
    • Styling & Customization
    • Custom Authentication
    • Search
    • Translation
  • Customer Portal
    • Overview
    • Styling & Customization
    • Access Control
    • Portal Experience
    • Custom Authentication
  • In-App Chat
    • Overview
    • Styling
    • Functionality
    • Chat Experience
    • Chat Setup
    • Identity Verification
    • JavaScript API
  • Account Management
    • Accounts
    • Views
    • Notebooks
      • Blocks
    • Highlights
    • Fields
    • Copilot
    • Activities
      • Custom Activities
  • Reporting & Analytics
    • Analytics
    • Default Dashboards
    • Custom Dashboards
  • Broadcasts
    • Overview
    • Create a Broadcast
    • Analytics
  • Integrations
    • CRM
      • Salesforce
      • Hubspot
      • Attio
      • Pipedrive
    • Ticketing
      • Linear
      • GitHub Issues
      • Asana
      • Jira
    • Alerting
      • PagerDuty
      • Opsgenie
    • Chat
      • Slack
        • Internal Threads
        • Collect Data
        • Support Ticket Flow
        • Welcome Message
        • Bookmarks
        • Onboard Employees
        • Left Company
        • Slack Community
      • Microsoft Teams
      • Discord
    • Incident Management
      • incident.io
    • Call Recording
      • Gong
      • Fathom
      • Grain
      • Fireflies
  • Data Warehouse
    • Snowflake
    • BigQuery
  • Developer
    • API
      • Authentication
      • Errors
      • API reference
        • Attachments
        • Accounts
          • Activities
          • Highlights
        • Contacts
        • Custom Fields
        • Issues
        • Knowledge Base
        • Me
        • Messages
        • Tags
        • Teams
        • Ticket Forms
        • User roles
        • Users
      • External IDs
    • Custom Apps
    • Embedded Iframes
    • Webhooks
Powered by GitBook
On this page

Was this helpful?

  1. Developer
  2. API
  3. API reference

Teams

PreviousTagsNextTicket Forms

Last updated 4 months ago

Was this helpful?

get

Get a list of teams

Authorizations
Responses
200Success
application/json
400Error
application/json
404Error
application/json
500Error
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
200Success
application/json
400Error
application/json
404Error
application/json
500Error
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"
}
  • GET/teams
  • GET/teams/{id}
  • PATCH/teams/{id}
  • POST/teams
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
200Success
application/json
400Error
application/json
404Error
application/json
500Error
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
200Success
application/json
400Error
application/json
404Error
application/json
500Error
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"
}