> ## 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 variables > Lists the tenant's custom variables, optionally filtered by scope, plugin connection or key. ## OpenAPI ````yaml /api/services-api.yaml get /v1/tenants/{tenantID}/settings/variables 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}/settings/variables: get: tags: - Settings summary: List variables description: |- Lists the tenant's custom variables, optionally filtered by scope, plugin connection or key. operationId: ListVariablesController parameters: - in: path name: tenantID required: true schema: type: string - in: query name: scope required: false schema: description: Filter to only tenant-wide or plugin-scoped variables. enum: - tenant - plugin type: string - in: query name: pluginConnectionID required: false schema: description: Filter to variables scoped to this plugin connection. type: string - in: query name: variableKeys required: false schema: description: Filter to only these variable keys. items: type: string type: array responses: '200': content: application/json: schema: additionalProperties: false properties: variables: description: Variables matching the query. items: additionalProperties: false properties: createdAt: description: When this variable was created. format: date-time type: string deletedAt: description: When this variable was soft-deleted, if applicable. format: date-time nullable: true type: string pluginConnectionID: description: >- The plugin connection this variable belongs to, when scoped to a plugin. nullable: true type: string pluginURN: description: >- The plugin URN this variable belongs to, when scoped to a plugin. nullable: true type: string tenantID: description: The tenant this variable belongs to. type: string updatedAt: description: When this variable was last updated, if ever. format: date-time nullable: true type: string variableDescription: description: >- Free-text description of what this variable is used for. nullable: true type: string variableID: description: Unique identifier for this variable. type: string variableKey: description: Unique key used to reference this variable. type: string variableLabel: description: Human-readable label for this variable. type: string variableType: description: The scope this variable applies at. enum: - GLOBAL - TENANT - PLUGIN type: string variableValue: description: The value stored for this variable. type: string required: - variableID - tenantID - variableKey - variableLabel - variableValue - variableType - createdAt type: object type: array required: - variables type: object description: Response for status 200. '400': content: application/json: schema: properties: errors: items: oneOf: - $ref: '#/components/schemas/MissingTenantIDError' - $ref: '#/components/schemas/RequestValidationError' - $ref: '#/components/schemas/MissingPluginConnectionIDError' 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. | MissingPluginConnectionIDError (error_code 1200): scope is "plugin" but pluginConnectionID was not provided. '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 MissingPluginConnectionIDError: additionalProperties: false properties: error: enum: - MissingPluginConnectionIDError type: string error_code: enum: - 1200 type: number message: example: pluginConnectionID is required for plugin-scoped operations. type: string statusCode: enum: - 400 type: number required: - statusCode - error - error_code - message 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 `. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.