Gladly Inboxes API

openapi: 3.2.0
info:
  title: Gladly Inboxes 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: Inboxes
  description: 'An **Inbox** receives customer communications in Gladly. The communications route to the inbox according to channel and destination endpoint configuration.

    For example, all calls to a specific phone number or emails to a specific address may go to an inbox.'
paths:
  /api/v1/inboxes:
    get:
      tags:
      - Inboxes
      summary: List Inboxes
      description: Returns a list of inbox metadata.
      operationId: getInboxes
      responses:
        '200':
          description: Inboxes
          content:
            application/json:
              schema:
                title: Inboxes
                type: array
                items:
                  $ref: '#/paths/~1api~1v1~1inboxes~1%7BinboxId%7D/get/responses/200/content/application~1json/schema'
  /api/v1/inboxes/{inboxId}:
    parameters:
    - name: inboxId
      in: path
      description: id of the inbox
      required: true
      schema:
        type: string
        example: vZgCEQlDR6aQz_0HeWZ9_Q
    get:
      tags:
      - Inboxes
      summary: Get Inbox
      description: Get the metadata for an inbox by its unique id.
      operationId: getInbox
      responses:
        '200':
          description: Inbox
          content:
            application/json:
              schema:
                title: Inbox
                type: object
                properties:
                  id:
                    type: string
                    description: Id of the inbox
                    example: vZgCEQlDR6aQz_0HeWZ9_Q
                  name:
                    type: string
                    description: Name of your inbox
                    example: Email Inbox
                  disabled:
                    type: boolean
                    description: Marks the inbox as disabled
                    example: false
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