> ## 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.

# List operator shortcuts

> Lists the shortcuts the requesting operator can see: their own personal
shortcuts plus every company-wide one. Ordering is fixed — personal before
company-wide, then alphabetical — so pagination stays stable across pages.
Returns HTTP 206 instead of 200 when more pages are available.



## OpenAPI

````yaml /api/services-api.yaml get /v1/tenants/{tenantID}/operators/shortcuts
openapi: 3.0.3
info:
  description: >-
    Talqui is an omnichannel customer service platform that unifies
    conversations from WhatsApp, Instagram, Telegram, and many other channels
    into a single attendant panel, alongside a broader ecosystem of plugins and
    integrations. This API gives developers programmatic access to Talqui's
    services layer, exposing the operations needed to read and manage tenants,
    conversations, plugins, and related resources that power that platform.


    Authentication is available on behalf of an Operator (the default for this
    API), a Plugin Connection, or a Plugin — see the [Talqui authentication
    guide](https://docs.talqui.chat/guides/introduction/authentication/) for how
    each token is obtained and when to use it.


    Need help or have questions not covered here? Reach out to
    support@talqui.com.
  license:
    name: ISC
    url: https://opensource.org/license/isc-license-txt
  title: Talqui - Services API
  version: 0.65.0
servers:
  - description: Production
    url: https://services-api.talqui.chat
security: []
tags:
  - name: Tenants
  - name: Settings
  - name: Analytics
  - name: Campaigns
  - name: Campaigns models
  - name: Contacts
  - name: Handoff links
  - name: Inboxes
  - name: Messages
  - name: Notifications
  - name: Sessions
  - name: Operators
  - name: Plugins
  - name: Setup
  - name: Uploads
paths:
  /v1/tenants/{tenantID}/operators/shortcuts:
    get:
      tags:
        - Operators
      summary: List operator shortcuts
      description: >-
        Lists the shortcuts the requesting operator can see: their own personal

        shortcuts plus every company-wide one. Ordering is fixed — personal
        before

        company-wide, then alphabetical — so pagination stays stable across
        pages.

        Returns HTTP 206 instead of 200 when more pages are available.
      operationId: ListOperatorShortcutsController
      parameters:
        - in: path
          name: tenantID
          required: true
          schema:
            type: string
        - in: query
          name: page
          required: false
          schema:
            default: 1
            description: 1-indexed page number to fetch.
            maximum: 9007199254740991
            minimum: 1
            type: integer
        - in: query
          name: perPage
          required: false
          schema:
            default: 100
            description: Number of shortcuts per page (max 200).
            maximum: 200
            minimum: 1
            type: integer
        - in: query
          name: scope
          required: false
          schema:
            description: Restricts the result to a single scope; omit for both.
            enum:
              - tenant-based
              - user-based
            type: string
        - in: query
          name: search
          required: false
          schema:
            description: Case-insensitive match against the shortcut name and preview.
            maxLength: 120
            minLength: 1
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    description: The shortcuts visible to the requesting operator.
                    items:
                      additionalProperties: false
                      properties:
                        createdAt:
                          description: When this shortcut was created.
                          format: date-time
                          type: string
                        operatorID:
                          description: The operator who owns this shortcut.
                          type: string
                        organizationID:
                          description: The organization the owning operator belongs to.
                          type: string
                        shortcutBang:
                          description: The shortcut name, searched from the inbox panel.
                          type: string
                        shortcutContents:
                          description: Ordered content blocks.
                          items:
                            oneOf:
                              - additionalProperties: false
                                properties:
                                  contentID:
                                    description: Stable identifier for this block.
                                    type: string
                                  contentKey:
                                    enum:
                                      - text
                                    type: string
                                  contentValue:
                                    description: >-
                                      Markdown text block in the Talqui message
                                      format
                                    maxLength: 5000
                                    minLength: 1
                                    type: string
                                required:
                                  - contentKey
                                  - contentValue
                                  - contentID
                                type: object
                              - additionalProperties: false
                                properties:
                                  contentID:
                                    description: Stable identifier for this block.
                                    type: string
                                  contentKey:
                                    enum:
                                      - file
                                      - image
                                      - video
                                      - document
                                    type: string
                                  contentValue:
                                    additionalProperties: false
                                    properties:
                                      address:
                                        description: >-
                                          Public storage URL returned by the
                                          signed-upload endpoint.
                                        format: uri
                                        type: string
                                      caption:
                                        description: >-
                                          Optional caption dispatched alongside
                                          the file.
                                        maxLength: 1024
                                        type: string
                                      fileName:
                                        description: >-
                                          Original file name, shown in the
                                          attachment card.
                                        minLength: 1
                                        type: string
                                      fileSizeInBytes:
                                        description: File size in bytes; capped at 12 MB.
                                        exclusiveMinimum: true
                                        maximum: 12000000
                                        type: integer
                                      mimeType:
                                        description: MIME type of the uploaded asset.
                                        minLength: 1
                                        type: string
                                    required:
                                      - address
                                      - mimeType
                                      - fileName
                                      - fileSizeInBytes
                                    type: object
                                required:
                                  - contentKey
                                  - contentValue
                                  - contentID
                                type: object
                              - additionalProperties: false
                                properties:
                                  contentID:
                                    description: Stable identifier for this block.
                                    type: string
                                  contentKey:
                                    enum:
                                      - audio
                                    type: string
                                  contentValue:
                                    additionalProperties: false
                                    properties:
                                      address:
                                        description: >-
                                          Public storage URL returned by the
                                          signed-upload endpoint.
                                        format: uri
                                        type: string
                                      caption:
                                        description: >-
                                          Optional caption dispatched alongside
                                          the file.
                                        maxLength: 1024
                                        type: string
                                      duration:
                                        description: Audio duration in seconds.
                                        minimum: 0
                                        type: number
                                      fileName:
                                        description: >-
                                          Original file name, shown in the
                                          attachment card.
                                        minLength: 1
                                        type: string
                                      fileSizeInBytes:
                                        description: File size in bytes; capped at 12 MB.
                                        exclusiveMinimum: true
                                        maximum: 12000000
                                        type: integer
                                      mimeType:
                                        description: MIME type of the uploaded asset.
                                        minLength: 1
                                        type: string
                                    required:
                                      - address
                                      - mimeType
                                      - fileName
                                      - fileSizeInBytes
                                      - duration
                                    type: object
                                required:
                                  - contentKey
                                  - contentValue
                                  - contentID
                                type: object
                          type: array
                        shortcutID:
                          description: Unique identifier for this shortcut.
                          type: string
                        shortcutPreview:
                          description: Derived plain-text summary used by list views.
                          type: string
                        shortcutScope:
                          description: Visibility scope of this shortcut.
                          enum:
                            - tenant-based
                            - user-based
                          type: string
                        tenantID:
                          description: The tenant this shortcut belongs to.
                          type: string
                        updatedAt:
                          description: When this shortcut was last modified.
                          format: date-time
                          type: string
                      required:
                        - shortcutID
                        - tenantID
                        - operatorID
                        - shortcutBang
                        - shortcutScope
                        - shortcutContents
                        - shortcutPreview
                        - createdAt
                        - updatedAt
                      type: object
                    type: array
                  meta:
                    additionalProperties: false
                    description: Pagination metadata.
                    properties:
                      count:
                        description: Number of shortcuts in this page.
                        type: number
                      currentPage:
                        description: The page returned by this response.
                        type: number
                      hasMore:
                        description: Whether more pages are available.
                        type: boolean
                      perPage:
                        description: Page size used for this response.
                        type: number
                      totalCount:
                        description: Total number of shortcuts matching the query.
                        type: number
                      totalPages:
                        description: Total number of pages available.
                        type: number
                    required:
                      - hasMore
                      - count
                      - totalCount
                      - totalPages
                      - currentPage
                      - perPage
                    type: object
                required:
                  - data
                  - meta
                type: object
          description: Response for status 200.
        '206':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    description: The shortcuts visible to the requesting operator.
                    items:
                      additionalProperties: false
                      properties:
                        createdAt:
                          description: When this shortcut was created.
                          format: date-time
                          type: string
                        operatorID:
                          description: The operator who owns this shortcut.
                          type: string
                        organizationID:
                          description: The organization the owning operator belongs to.
                          type: string
                        shortcutBang:
                          description: The shortcut name, searched from the inbox panel.
                          type: string
                        shortcutContents:
                          description: Ordered content blocks.
                          items:
                            oneOf:
                              - additionalProperties: false
                                properties:
                                  contentID:
                                    description: Stable identifier for this block.
                                    type: string
                                  contentKey:
                                    enum:
                                      - text
                                    type: string
                                  contentValue:
                                    description: >-
                                      Markdown text block in the Talqui message
                                      format
                                    maxLength: 5000
                                    minLength: 1
                                    type: string
                                required:
                                  - contentKey
                                  - contentValue
                                  - contentID
                                type: object
                              - additionalProperties: false
                                properties:
                                  contentID:
                                    description: Stable identifier for this block.
                                    type: string
                                  contentKey:
                                    enum:
                                      - file
                                      - image
                                      - video
                                      - document
                                    type: string
                                  contentValue:
                                    additionalProperties: false
                                    properties:
                                      address:
                                        description: >-
                                          Public storage URL returned by the
                                          signed-upload endpoint.
                                        format: uri
                                        type: string
                                      caption:
                                        description: >-
                                          Optional caption dispatched alongside
                                          the file.
                                        maxLength: 1024
                                        type: string
                                      fileName:
                                        description: >-
                                          Original file name, shown in the
                                          attachment card.
                                        minLength: 1
                                        type: string
                                      fileSizeInBytes:
                                        description: File size in bytes; capped at 12 MB.
                                        exclusiveMinimum: true
                                        maximum: 12000000
                                        type: integer
                                      mimeType:
                                        description: MIME type of the uploaded asset.
                                        minLength: 1
                                        type: string
                                    required:
                                      - address
                                      - mimeType
                                      - fileName
                                      - fileSizeInBytes
                                    type: object
                                required:
                                  - contentKey
                                  - contentValue
                                  - contentID
                                type: object
                              - additionalProperties: false
                                properties:
                                  contentID:
                                    description: Stable identifier for this block.
                                    type: string
                                  contentKey:
                                    enum:
                                      - audio
                                    type: string
                                  contentValue:
                                    additionalProperties: false
                                    properties:
                                      address:
                                        description: >-
                                          Public storage URL returned by the
                                          signed-upload endpoint.
                                        format: uri
                                        type: string
                                      caption:
                                        description: >-
                                          Optional caption dispatched alongside
                                          the file.
                                        maxLength: 1024
                                        type: string
                                      duration:
                                        description: Audio duration in seconds.
                                        minimum: 0
                                        type: number
                                      fileName:
                                        description: >-
                                          Original file name, shown in the
                                          attachment card.
                                        minLength: 1
                                        type: string
                                      fileSizeInBytes:
                                        description: File size in bytes; capped at 12 MB.
                                        exclusiveMinimum: true
                                        maximum: 12000000
                                        type: integer
                                      mimeType:
                                        description: MIME type of the uploaded asset.
                                        minLength: 1
                                        type: string
                                    required:
                                      - address
                                      - mimeType
                                      - fileName
                                      - fileSizeInBytes
                                      - duration
                                    type: object
                                required:
                                  - contentKey
                                  - contentValue
                                  - contentID
                                type: object
                          type: array
                        shortcutID:
                          description: Unique identifier for this shortcut.
                          type: string
                        shortcutPreview:
                          description: Derived plain-text summary used by list views.
                          type: string
                        shortcutScope:
                          description: Visibility scope of this shortcut.
                          enum:
                            - tenant-based
                            - user-based
                          type: string
                        tenantID:
                          description: The tenant this shortcut belongs to.
                          type: string
                        updatedAt:
                          description: When this shortcut was last modified.
                          format: date-time
                          type: string
                      required:
                        - shortcutID
                        - tenantID
                        - operatorID
                        - shortcutBang
                        - shortcutScope
                        - shortcutContents
                        - shortcutPreview
                        - createdAt
                        - updatedAt
                      type: object
                    type: array
                  meta:
                    additionalProperties: false
                    description: Pagination metadata.
                    properties:
                      count:
                        description: Number of shortcuts in this page.
                        type: number
                      currentPage:
                        description: The page returned by this response.
                        type: number
                      hasMore:
                        description: Whether more pages are available.
                        type: boolean
                      perPage:
                        description: Page size used for this response.
                        type: number
                      totalCount:
                        description: Total number of shortcuts matching the query.
                        type: number
                      totalPages:
                        description: Total number of pages available.
                        type: number
                    required:
                      - hasMore
                      - count
                      - totalCount
                      - totalPages
                      - currentPage
                      - perPage
                    type: object
                required:
                  - data
                  - meta
                type: object
          description: Response for status 206.
        '400':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      oneOf:
                        - $ref: '#/components/schemas/MissingTenantIDError'
                        - $ref: '#/components/schemas/RequestValidationError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            MissingTenantIDError (error_code 1001): tenantID absent from the
            URL. | RequestValidationError (error_code 1002): query params fail
            schema validation.
        '401':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/UnauthorizedError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: 'UnauthorizedError (error_code 1003): missing/invalid operator token.'
        '403':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/ForbiddenError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: 'ForbiddenError (error_code 1004): operator token rejected upstream.'
        '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: []
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
    RequestValidationError:
      additionalProperties: false
      properties:
        error:
          enum:
            - RequestValidationError
          type: string
        error_code:
          enum:
            - 1002
          type: number
        fields:
          items:
            additionalProperties: false
            properties:
              allowed:
                type: string
              field:
                type: string
              received:
                type: string
            required:
              - field
              - received
              - allowed
            type: object
          type: array
        message:
          example: Invalid request data.
          type: string
        statusCode:
          enum:
            - 400
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
        - fields
      type: object
    UnauthorizedError:
      additionalProperties: false
      properties:
        error:
          enum:
            - UnauthorizedError
          type: string
        error_code:
          enum:
            - 1003
          type: number
        message:
          example: You are not authorized to perform this request.
          type: string
        statusCode:
          enum:
            - 401
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    ForbiddenError:
      additionalProperties: false
      properties:
        error:
          enum:
            - ForbiddenError
          type: string
        error_code:
          enum:
            - 1004
          type: number
        message:
          example: You do not have access to this resource.
          type: string
        statusCode:
          enum:
            - 403
          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 (default). A JWT issued by Talqui Core when an
        operator signs in, scoped to every tenant that operator belongs to. Send
        as `Authorization: Bearer <jwt-token>`.
      scheme: bearer
      type: http

````

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