Gladly Organization API

openapi: 3.2.0
info:
  title: Gladly Organization 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: Organization
  description: An **Organization** contains metadata about your company that Gladly is configured with.
paths:
  /api/v1/organization:
    get:
      tags:
      - Organization
      summary: Get Organization
      description: Returns metadata about your organization.
      operationId: getOrganization
      responses:
        '200':
          description: Organization
          content:
            application/json:
              schema:
                title: Organization
                type: object
                properties:
                  id:
                    type: string
                    description: Id of your organization
                    example: ihKsWxiZCDVtXg1iwVmT9Q
                  loginDomain:
                    type: string
                    description: Email domain of your organization
                    example: organization.com
                  name:
                    type: string
                    description: Name of your organization
                    example: My Organization
                  timezone:
                    type: string
                    description: Timezone for your organization
                    example: America/Los_Angeles
                  gladlyUrl:
                    type: string
                    description: Url for your organization
                    example: https://organization.gladly.com
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