> ## Documentation Index > Fetch the complete documentation index at: https://docs.unleashx.ai/llms.txt > Use this file to discover all available pages before exploring further. # List Input Variables > Retrieve a paginated list of input variables for the workspace (System + User Defined), including where each variable is currently used and whether it can be edited or deleted. Use this endpoint to **retrieve a paginated list of input variables** for the workspace, including where each variable is currently used. ## Endpoint **GET** `/input-variable/list` **Authentication:** Required (workspace auth) ## Query Parameters | Parameter | Type | Required | Description | | ------------ | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `page` | number | No | Page number (default: `1`) | | `limit` | number | No | Records per page (default: `10`) | | `search` | string | No | Partial match against `variable_key` | | `source` | string | No | `system` or `user` — filter by variable origin | | `type` | string | No | One or more data types, comma-separated (e.g. `string,name`). See [Variable Types](#variable-types). | | `agent_type` | number | No | Agent type the list is being requested for: `2` (Chat), `3` (Voice), `4` (General). Hides System variables that don't apply to that agent type (see Behavior). | ## Variable Types | Value | | --------- | | `string` | | `number` | | `date` | | `email` | | `phone` | | `name` | | `amount` | | `address` | | `pincode` | | `no_type` | ## Response ```json theme={null} { "datalist": [ { "id": 1, "variable_key": "mobile_no", "type": "phone", "description": "Contact mobile number", "source": "System", "is_required": 1, "is_disabled": 0, "used_in": [], "show_edit": 0, "show_delete": 0, "update_description": "System variables cannot be updated.", "delete_description": "System variables cannot be deleted.", "updated_by": "", "updated_on": "" }, { "id": 57, "variable_key": "customer_plan", "type": "string", "description": "Subscription plan name", "source": "User Defined", "is_required": 0, "is_disabled": 0, "used_in": [ { "id": 8, "name": "Renewal Agent", "type": "agent" }, { "id": 21, "name": "Q4 Leads", "type": "audience" } ], "show_edit": 0, "show_delete": 0, "update_description": "The input variable is linked to 1 active agent and 1 active audience. First remove it from the agents and audiences to update.", "delete_description": "The input variable is linked to 1 active agent and 1 active audience. First remove it from the agents and audiences to delete.", "updated_by": "Jane Admin", "updated_on": "10 Dec, 2025" } ], "pagination": { "totalRecords": 24, "totalPages": 3, "currentPage": 1, "limit": 10 } } ``` | Field | Type | Description | | ------------------------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------- | | `used_in` | array | Every agent and audience currently referencing the variable, as `{ id, name, type }` where `type` is `agent` or `audience`. | | `show_edit` / `show_delete` | number (0/1) | Whether the edit/delete action is allowed for this row. Always `0` for System variables and for any variable currently listed in `used_in`. | | `update_description` / `delete_description` | string | Human-readable reason the action is locked (empty string when allowed). | ## Behavior * Returns the workspace's own User Defined variables **plus** the global System variables (`COMPANY_ID = 0`, `WORKSPACE_ID = 0`), so built-in variables show up in every workspace's list. * Results are sorted System variables first, then User Defined, both by ascending ID. * `agent_type` filters out System variables that don't apply to that agent type. Currently `mobile_no` is excluded when `agent_type` is `2` (Chat) or `4` (General) — Voice agents (`3`) keep it. * `used_in` is computed by scanning every non-deleted audience's saved variable keys and every non-deleted agent flow's `metadata_input` declarations, so it reflects live usage at request time. * A variable can only be edited or deleted when it is **User Defined** and **not** referenced by any agent or audience — otherwise `show_edit`/`show_delete` are `0` and the corresponding `*_description` field explains why. ## Example cURL ```bash theme={null} curl -X GET "https://www.tryunleashx.com/api/v1/global/input-variable/list?page=1&limit=10&source=user" \ -H "token: " ``` ## OpenAPI ````yaml api-reference/openapi.json GET /input-variable/list openapi: 3.1.0 info: title: >- UnleashX - Build human like conversations | Voice Agents | Automations | AI Workforce version: 1.0.0 description: UnleashX - Your home for human like conversations servers: - url: https://www.tryunleashx.com/api/v1/global/ security: - bearerAuth: [] paths: /input-variable/list: get: tags: - Input Variables summary: List input variables description: >- Retrieve a paginated list of input variables for the workspace (System + User Defined), including where each variable is currently used and whether it can be edited or deleted. parameters: - name: token in: header required: true description: API token for authentication schema: type: string - name: page in: query required: false schema: type: integer description: 'Page number (default: 1)' - name: limit in: query required: false schema: type: integer description: 'Records per page (default: 10)' - name: search in: query required: false schema: type: string description: Partial match against variable_key - name: source in: query required: false schema: type: string enum: - system - user description: Filter by variable origin - name: type in: query required: false schema: type: string description: One or more data types, comma-separated (e.g. string,name) - name: agent_type in: query required: false schema: type: integer enum: - 2 - 3 - 4 description: >- 2=Chat, 3=Voice, 4=General. Hides System variables not applicable to that agent type (currently mobile_no for 2 and 4). responses: '200': description: Input variables retrieved successfully content: application/json: schema: type: object properties: datalist: type: array items: type: object pagination: type: object properties: totalRecords: type: integer totalPages: type: integer currentPage: type: integer limit: type: integer '400': description: Bad Request '401': description: Unauthorized security: [] components: securitySchemes: bearerAuth: type: http scheme: bearer ````