Gladly Public Answer API

openapi: 3.2.0
info:
  title: Gladly Public Answer 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: Public Answer
  description: A **Public Answer** in Gladly represents a consumer-facing Answer.
paths:
  /api/v1/orgs/{orgId}/answers-search?q=search+terms:
    get:
      tags:
      - Public Answer
      summary: Search Public Answers
      description: Returns a list of answers that match the provided query string.
      operationId: searchAnswers
      parameters:
      - name: orgId
        in: path
        description: 'id of your organization


          You can look up the ID using the [Get organization](index.html#tag/Organization) API.

          '
        required: true
        schema:
          type: string
          example: ihKsWxiZCDVtXg1iwVmT9Q
      - name: q
        in: query
        description: search term
        schema:
          type: string
          example: reset%20password
      - name: lng
        in: query
        description: language code
        schema:
          type: string
          example: en-us
      - name: audienceId
        in: query
        description: Audience ID. The Audience ID can be retrieved by going to Settings > Audiences in Gladly, then clicking on the Edit button next to the Audience in question. The ID will be in the page URL.
        schema:
          type: string
          example: en-us
      responses:
        '200':
          description: found answers
          content:
            application/json:
              schema:
                type: array
                items:
                  properties:
                    id:
                      type: string
                      description: unique answer id
                      example: 1grfSzATQLa334VDLCWc4A
                    name:
                      type: string
                      description: Customer facing answer name
                      example: How to reset your password
  /api/v1/orgs/{orgId}/answers?lng={lng}&audienceId={audienceId}:
    get:
      tags:
      - Public Answer
      summary: List Public Answers
      description: Returns the first 1000 public answers sorted alphabetically by name.
      operationId: listAnswers
      parameters:
      - name: orgId
        in: path
        description: 'id of your organization


          You can look up the ID using the [Get organization](index.html#tag/Organization) API.

          '
        required: true
        schema:
          type: string
          example: ihKsWxiZCDVtXg1iwVmT9Q
      - name: lng
        in: query
        description: 'Language of the answers returned


          Defaults to `en-us`

          '
        schema:
          type: string
          example: es-419
      - name: audienceId
        in: query
        description: 'Audience ID for answers returned - optional. The Audience ID can be retrieved by going to Settings > Audiences in Gladly, then clicking on the Edit button next to the Audience in question. The ID will be in the page URL.

          '
        schema:
          type: string
          example: ihKsWxiZCDVtXg1iwVmT9Q
      responses:
        '200':
          description: answers
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/paths/~1api~1v1~1orgs~1%7BorgId%7D~1answers~1%7BanswerId%7D/get/responses/200/content/application~1json/schema'
  /api/v1/orgs/{orgId}/help-center/{helpCenterId}/answer-titles?lng={lng}&audienceId={audienceId}:
    get:
      tags:
      - Public Answer
      summary: List Help Center Answer Titles
      description: Returns an array of answers configured in Help Center sections with their ID and name
      operationId: getAnswerTitles
      parameters:
      - name: orgId
        in: path
        description: 'id of your organization


          You can look up the ID using the [Get organization](index.html#tag/Organization) API.

          '
        required: true
        schema:
          type: string
          example: ihKsWxiZCDVtXg1iwVmT9Q
      - name: helpCenterId
        in: path
        description: 'Help Center ID


          You can look up the ID by going to Settings > Help Center in Gladly, then clicking on the 3 dots next to the Help Center and selecting Configure. Help Center ID will be in the URL

          '
        required: true
        schema:
          type: string
          example: ihKsWxiZCDVtXg1iwVmT9Q
      - name: lng
        in: query
        description: 'Language of the answers returned


          Defaults to `en-us`

          '
        schema:
          type: string
          example: es-419
      - name: audienceId
        in: query
        description: 'Audience ID for answers returned - optional. The Audience ID can be retrieved by going to Settings > Audiences in Gladly, then clicking on the Edit button next to the Audience in question. The ID will be in the page URL.

          '
        schema:
          type: string
          example: ihKsWxiZCDVtXg1iwVmT9Q
      responses:
        '200':
          description: answers
          content:
            application/json:
              schema:
                type: array
                items:
                  properties:
                    id:
                      type: string
                      description: unique answer id
                      example: 1grfSzATQLa334VDLCWc4A
                    name:
                      type: string
                      description: Customer facing answer name
                      example: How to reset your password
  /api/v1/orgs/{orgId}/answers/{answerId}:
    get:
      tags:
      - Public Answer
      summary: Get Public Answer
      description: Returns the answer with the provided id.
      operationId: getAnswer
      parameters:
      - name: orgId
        in: path
        description: 'id of your organization


          You can look up the ID using the [Get organization](index.html#tag/Organization) API.

          '
        required: true
        schema:
          type: string
          example: ihKsWxiZCDVtXg1iwVmT9Q
      - name: answerId
        in: path
        description: id of the answer
        required: true
        schema:
          type: string
          example: 1grfSzATQLa334VDLCWc4A
      - name: lng
        in: query
        description: language code
        schema:
          type: string
          example: en-us
      responses:
        '200':
          description: answer
          content:
            application/json:
              schema:
                properties:
                  id:
                    type: string
                    description: unique answer id
                    example: 1grfSzATQLa334VDLCWc4A
                  name:
                    type: string
                    description: Customer facing answer name
                    example: How to reset your password
                  bodyHtml:
                    type: string
                    description: Public answer content
                    example: <div><a href="/reset-password">Click here</a> to reset your password</div>
                  language:
                    type: string
                    description: Answer language
                    example: en-us
                  updatedAt:
                    type: string
                    format: RFC3339 with millis
                    description: Time the answer was last updated
                    example: '2023-05-22T10:00:00.000Z'
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