pocketenv / apps / api / lexicons / variable / getVariables.json

{
  "lexicon": 1,
  "id": "io.pocketenv.variable.getVariables",
  "defs": {
    "main": {
      "type": "query",
      "parameters": {
        "type": "params",
        "properties": {
          "sandboxId": {
            "type": "string",
            "description": "The ID of the sandbox for which to retrieve variables."
          },
          "limit": {
            "type": "integer",
            "description": "The maximum number of variables to return.",
            "minimum": 1
          },
          "offset": {
            "type": "integer",
            "description": "The number of variables to skip before starting to collect the result set.",
            "minimum": 0
          }
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "properties": {
            "variables": {
              "type": "array",
              "items": {
                "type": "ref",
                "ref": "io.pocketenv.variable.defs#variableView"
              }
            },
            "total": {
              "type": "integer",
              "description": "The total number of variables available.",
              "minimum": 0
            }
          }
        }
      }
    }
  }
}