---
updatedAt: 2026-05-05T11:11:03.000Z
agentTools:
  projectIndex: https://docs.scalr.io/llms.txt
---

# List workspaces variable sets

This endpoint returns a list of variable sets linked to the workspace.


# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "WorkspaceVariableSetRelationship": {
        "description": "Describes JSON:API generic Resource Identifier object.\nsee https://jsonapi.org/format/#document-resource-identifier-objects",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "enum": [
              "var-sets"
            ],
            "type": "string"
          }
        },
        "required": [
          "type",
          "id"
        ],
        "type": "object"
      },
      "WorkspaceVariableSetRelationshipFieldsetsListingDocument": {
        "description": "Document Listing.",
        "properties": {
          "data": {
            "items": {
              "$ref": "#/components/schemas/WorkspaceVariableSetRelationship"
            },
            "type": "array"
          },
          "included": {
            "items": {
              "type": "object"
            },
            "readOnly": true,
            "type": "array"
          },
          "links": {
            "additionalProperties": {
              "type": "string"
            },
            "readOnly": true,
            "type": "object"
          },
          "meta": {
            "readOnly": true,
            "type": "object"
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "API-Key": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "description": "Scalr IACP API",
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0"
    },
    "title": "Scalr IACP API",
    "version": "unversioned"
  },
  "openapi": "3.0.0",
  "paths": {
    "/workspaces/{workspace}/relationships/var-sets": {
      "get": {
        "description": "This endpoint returns a list of variable sets linked to the workspace.\n",
        "operationId": "list_workspace_variable_sets",
        "parameters": [
          {
            "description": "The ID of the workspace.\n",
            "in": "path",
            "name": "workspace",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Page number",
            "in": "query",
            "name": "page[number]",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Page size",
            "in": "query",
            "name": "page[size]",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkspaceVariableSetRelationshipFieldsetsListingDocument"
                }
              }
            },
            "description": "Request was successful."
          },
          "403": {
            "description": "User unauthorized to perform this action."
          },
          "404": {
            "description": "Workspace not found."
          },
          "4XX": {
            "description": "Client error."
          },
          "5XX": {
            "description": "Server error."
          }
        },
        "summary": "List workspaces variable sets",
        "tags": [
          "workspace-variable-sets"
        ],
        "x-resource": "Workspace",
        "x-service": "tf-api"
      }
    }
  },
  "security": [
    {
      "API-Key": []
    }
  ],
  "servers": [
    {
      "url": "https://{Domain}/api/iacp/v3",
      "variables": {
        "Domain": {
          "default": "example.scalr.io",
          "description": "Domain where Scalr is hosted"
        }
      }
    }
  ]
}
```

# Sibling pages

* [Delete assigned variable sets from the workspace](https://docs.scalr.io/scalr/reference/delete_workspace_variable_sets.md)
* [Replace assigned variable sets on the workspace](https://docs.scalr.io/scalr/reference/replace_workspace_variable_sets.md)
* [Assign variable sets to the workspace](https://docs.scalr.io/scalr/reference/add_workspace_variable_sets.md)