> ## Documentation Index
> Fetch the complete documentation index at: https://docs.talqui.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# Get helpdesk catalog

> The published catalog of the tenant's help center — categories, articles
and each article's absolute public URL — in one call, for a caller that
needs to pick an article and paste its link.

Only published articles, always: this is read by operators in the middle of
an attendance, and a draft has no address to send anyone to. A help center
that is itself still in draft answers with an empty catalog rather than
links that would 404 in front of the customer.



## OpenAPI

````yaml /api/helpdesk.yaml get /v1/tenants/{tenantID}/helpdesk/catalog
openapi: 3.0.3
info:
  description: >-
    Help center API for the Talqui Helpdesk plugin. Two surfaces with different
    audiences: authenticated authoring routes under /v1/tenants/:tenantID, and
    anonymous public reads under /v1/public resolved from the request hostname.
  license:
    name: ISC
    url: https://opensource.org/license/isc-license-txt
  title: Talqui Helpdesk API
  version: 0.10.0
servers:
  - description: Production
    url: https://plugins-api.talqui.chat/helpdesk
security: []
tags:
  - name: Install
  - name: Public
  - name: Helpdesk
  - name: Helpdesk/Domains
  - name: Categories
  - name: Articles
paths:
  /v1/tenants/{tenantID}/helpdesk/catalog:
    get:
      tags:
        - Helpdesk
      summary: Get helpdesk catalog
      description: >-
        The published catalog of the tenant's help center — categories, articles

        and each article's absolute public URL — in one call, for a caller that

        needs to pick an article and paste its link.


        Only published articles, always: this is read by operators in the middle
        of

        an attendance, and a draft has no address to send anyone to. A help
        center

        that is itself still in draft answers with an empty catalog rather than

        links that would 404 in front of the customer.
      operationId: GetHelpdeskCatalogController
      parameters:
        - in: path
          name: tenantID
          required: true
          schema:
            description: The tenant the help center belongs to.
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  articles:
                    items:
                      additionalProperties: false
                      properties:
                        articleDescription:
                          type: string
                        articleFeatured:
                          type: boolean
                        articleID:
                          type: string
                        articleOrder:
                          type: number
                        articleSlug:
                          type: string
                        articleTitle:
                          type: string
                        articleUrl:
                          type: string
                        categoryID:
                          type: string
                        publishedAt:
                          format: date-time
                          nullable: true
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                          type: string
                      required:
                        - articleID
                        - categoryID
                        - articleTitle
                        - articleSlug
                        - articleDescription
                        - articleUrl
                        - articleOrder
                        - articleFeatured
                        - publishedAt
                      type: object
                    type: array
                  articlesTotal:
                    type: number
                  categories:
                    items:
                      additionalProperties: false
                      properties:
                        categoryID:
                          type: string
                        categoryOrder:
                          type: number
                        categorySlug:
                          type: string
                        categoryTitle:
                          type: string
                      required:
                        - categoryID
                        - categoryTitle
                        - categorySlug
                        - categoryOrder
                      type: object
                    type: array
                  helpdeskBaseUrl:
                    nullable: true
                    type: string
                  helpdeskID:
                    type: string
                  helpdeskStatus:
                    enum:
                      - draft
                      - published
                    type: string
                  truncated:
                    type: boolean
                required:
                  - helpdeskID
                  - helpdeskStatus
                  - helpdeskBaseUrl
                  - categories
                  - articles
                  - articlesTotal
                  - truncated
                type: object
          description: Response for status 200.
        '400':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/MissingTenantIDError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            MissingTenantIDError (error_code 1001): tenantID absent from the
            URL.
        '404':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/HelpdeskNotFoundError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            HelpdeskNotFoundError (error_code 1107): the tenant has no help
            center yet.
        '422':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/TenantNotConnectedError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            TenantNotConnectedError (error_code 1000): the tenant is not
            connected to the plugin.
        '500':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/UnknownError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            UnknownError (error_code 5999): Unexpected internal error not
            otherwise documented for this endpoint.
      security:
        - operatorAuth: []
        - pluginConnectionAuth: []
        - pluginAuth: []
components:
  schemas:
    MissingTenantIDError:
      additionalProperties: false
      properties:
        error:
          enum:
            - MissingTenantIDError
          type: string
        error_code:
          enum:
            - 1001
          type: number
        message:
          example: tenantID is required.
          type: string
        statusCode:
          enum:
            - 400
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    HelpdeskNotFoundError:
      additionalProperties: false
      properties:
        error:
          enum:
            - HelpdeskNotFoundError
          type: string
        error_code:
          enum:
            - 1107
          type: number
        message:
          example: No help center answers on this address.
          type: string
        statusCode:
          enum:
            - 404
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    TenantNotConnectedError:
      additionalProperties: false
      properties:
        error:
          enum:
            - TenantNotConnectedError
          type: string
        error_code:
          enum:
            - 1000
          type: number
        message:
          example: This tenant is not connected to the plugin.
          type: string
        statusCode:
          enum:
            - 422
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    UnknownError:
      additionalProperties: false
      properties:
        error:
          enum:
            - UnknownError
          type: string
        error_code:
          enum:
            - 5999
          type: number
        message:
          example: For some unknown reason your request has not succeeded.
          type: string
        statusCode:
          enum:
            - 500
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
  securitySchemes:
    operatorAuth:
      bearerFormat: JWT
      description: >-
        Behalf of an Operator. The JWT issued by Talqui Core when an operator
        signs in. Send as `Authorization: Bearer <jwt-token>`.
      scheme: bearer
      type: http
    pluginConnectionAuth:
      description: >-
        Behalf of a Plugin Connection. Issued when the Helpdesk plugin is
        installed on a tenant; scoped strictly to that one tenant. Send as
        `Authorization: PluginConnection
        base64(pluginConnectionID:pluginConnectionToken)`.
      in: header
      name: Authorization
      type: apiKey
    pluginAuth:
      description: >-
        Behalf of the Helpdesk plugin itself, reaching every tenant that
        installed it. Send as `Authorization: Plugin
        base64(pluginID:pluginToken)`.
      in: header
      name: Authorization
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.