Gladly Teams API

openapi: 3.2.0
info:
  title: Gladly Teams API
  version: '1.0'
  description: '# Introducing the Gladly API


    At Gladly, we believe that customer service is best when it''s a conversation.'
servers:
- url: https://{organization}.gladly.com/api/v1
  description: Production
  variables:
    organization:
      default: organization
      description: Your Gladly organization subdomain
- url: https://{organization}.gladly.qa/api/v1
  description: Sandbox
  variables:
    organization:
      default: organization
      description: Your Gladly QA organization subdomain
security:
- basicAuth: []
tags:
- name: Teams
  description: A **Team** represents a group of Agents. They may handle particular **Inboxes** or types of work within Gladly.
paths:
  /api/v1/teams:
    get:
      tags:
      - Teams
      summary: List Teams
      description: Returns a list of teams.
      operationId: getTeams
      responses:
        '200':
          description: Teams
          content:
            application/json:
              schema:
                title: Teams
                type: array
                items:
                  $ref: '#/paths/~1api~1v1~1teams~1%7BteamId%7D/get/responses/200/content/application~1json/schema'
  /api/v1/teams/{teamId}:
    parameters:
    - name: teamId
      in: path
      description: id of the team
      required: true
      schema:
        type: string
        example: ovg2jQCQS9ScsDkBxG-o2Q
    get:
      tags:
      - Teams
      summary: Get Team
      description: Get a team by its unique id.
      operationId: getTeam
      responses:
        '200':
          description: Team
          content:
            application/json:
              schema:
                title: Team
                type: object
                properties:
                  id:
                    type: string
                    description: Id of the team
                    example: ovg2jQCQS9ScsDkBxG-o2Q
                  name:
                    type: string
                    description: Name of the team
                    example: Stay Advisors
                  description:
                    type: string
                    description: Description of the team
                    example: Team to answer customer questions about new bookings
                  agentIds:
                    type: array
                    description: Ids of the agents in the team
                    example:
                    - WmeA3Y51Q5ayCAaZ1AotIA
                    items:
                      type: string
components:
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: 'Gladly API uses token-based **Basic Authentication**. API tokens are associated with designated Gladly users.

        To create and use an API token, your user must have the API User permission. An API token can be used to perform any API request without restriction.


        | user name   | password  |

        | ----------- | --------- |

        | agent email | API token |


        The credentials must be passed via an `Authorization` HTTP header. All requests must be made over HTTPS.


        ```shell

        curl -u user@organization.com:$GLADLY_API_TOKEN \

        https://organization.gladly.com/api/v1/organization

        ```

        '
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic auth — username is the API user email; password is the API token. Requires the "API User" permission.
x-tagGroups:
- name: REST API
  tags:
  - Agents
  - Public Answer
  - Answer Management
  - Audiences
  - Business Hours
  - Communications
  - Conversations
  - Customers
  - Events
  - Export
  - Freeform Topics
  - Inboxes
  - Organization
  - Proactive Conversations
  - Reports
  - Tasks
  - Teams
  - User Identity
  - Topics
  - Webhooks
- name: Webhooks
  tags:
  - Summary
  - Payloads
- name: Lookup API
  tags:
  - Customer Lookup
- name: Resources
  tags:
  - Versioning
  - Error Handling
  - Rate Limit
  - Rich Content
  - Launching Soon