Skip to main content
GET
/
api
/
v1
/
dev
/
documents
/
{documentId}
/
variables
Get document variables
curl --request GET \
  --url https://api.autype.com/api/v1/dev/documents/{documentId}/variables \
  --header 'X-API-Key: <api-key>'
{
  "documentId": "<string>",
  "title": "<string>",
  "variables": {
    "companyName": {
      "type": "string"
    },
    "logo": {
      "type": "image",
      "width": 150
    },
    "items": {
      "type": "list"
    }
  },
  "variableNames": [
    "companyName",
    "logo",
    "items"
  ]
}

Authorizations

​
X-API-Key
string
header
required

API Key (starts with ak_...)

Path Parameters

​
documentId
string
required

Response

Document variable definitions

​
documentId
string
required

Document ID

​
title
string
required

Document title

​
variables
object
required

Variable definitions from the document

Example:
{
  "companyName": { "type": "string" },
  "logo": { "type": "image", "width": 150 },
  "items": { "type": "list" }
}
​
variableNames
string[]
required

List of variable names

Example:
["companyName", "logo", "items"]