Skip to main content
GET
/
document
/
v2beta1
/
documents
/
{documentId}
/
states
cURL
curl --request GET \
  --url https://aodocs.altirnao.com/api/document/v2beta1/documents/{documentId}/states \
  --header 'Authorization: Bearer <token>'
{
  "classId": "<string>",
  "className": "<string>",
  "domainName": "<string>",
  "kind": "<string>",
  "libraryId": "<string>",
  "libraryName": "<string>",
  "states": [
    {
      "annotationRestrictedViewers": [
        {
          "classId": "<string>",
          "className": "<string>",
          "description": "<string>",
          "displayName": "<string>",
          "displayName_i18n": "<string>",
          "thumbnailPictureUrl": "<string>",
          "value": "<string>"
        }
      ],
      "checkOutSettings": {
        "addValidatorToPermissions": true,
        "applyPreviousVersionPermissions": true,
        "draftActionPrefix": "<string>",
        "permissions": [
          {
            "displayName": "<string>",
            "kind": "<string>",
            "thumbnailPictureUrl": "<string>",
            "value": "<string>",
            "withLink": true
          }
        ]
      },
      "createdTime": "2023-11-07T05:31:56Z",
      "customActions": [
        {
          "id": "<string>",
          "kind": "<string>",
          "name": "<string>",
          "params": {},
          "scriptId": "<string>",
          "scriptName": "<string>"
        }
      ],
      "description": "<string>",
      "displayFlags": [],
      "draftDocuments": true,
      "hiddenFields": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "id": "<string>",
      "kind": "<string>",
      "lastModifiedTime": "2023-11-07T05:31:56Z",
      "mandatoryFields": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "name": "<string>",
      "name_i18n": "<string>",
      "notifications": {
        "actionEmail": {
          "customEmail": {
            "bodyTemplate": "<string>",
            "senderTemplate": "<string>",
            "subjectTemplate": "<string>"
          },
          "templateEmail": {
            "id": "<string>",
            "name": "<string>"
          }
        },
        "notificationEmail": {
          "customEmail": {
            "bodyTemplate": "<string>",
            "senderTemplate": "<string>",
            "subjectTemplate": "<string>"
          },
          "templateEmail": {
            "id": "<string>",
            "name": "<string>"
          }
        },
        "notifyHumanActionPerformer": true,
        "recipients": [
          {
            "classId": "<string>",
            "className": "<string>",
            "description": "<string>",
            "displayName": "<string>",
            "displayName_i18n": "<string>",
            "thumbnailPictureUrl": "<string>",
            "value": "<string>"
          }
        ]
      },
      "permissions": [
        {
          "displayName": "<string>",
          "kind": "<string>",
          "thumbnailPictureUrl": "<string>",
          "value": "<string>",
          "withLink": true
        }
      ],
      "readOnlyDocumentsNotCheckedOut": true,
      "readOnlyFields": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "resetDocumentPermissions": true,
      "transitions": [
        {
          "createNewDocumentVersion": true,
          "createdTime": "2023-11-07T05:31:56Z",
          "discardCheckedOutDocument": true,
          "elapsedTime": {
            "amount": 123
          },
          "fixedTime": "2023-11-07T05:31:56Z",
          "humanAction": {
            "actionId": "<string>",
            "appliedName": "<string>",
            "appliedName_i18n": "<string>",
            "commentPlaceholderText": "<string>",
            "commentPlaceholderText_i18n": "<string>",
            "mandatoryComment": true,
            "name": "<string>",
            "name_i18n": "<string>",
            "performer": {
              "classId": "<string>",
              "className": "<string>",
              "description": "<string>",
              "displayName": "<string>",
              "displayName_i18n": "<string>",
              "thumbnailPictureUrl": "<string>",
              "value": "<string>"
            },
            "reminders": [
              {
                "condition": {
                  "params": {},
                  "scriptId": "<string>",
                  "scriptName": "<string>"
                },
                "emailTemplateId": "<string>",
                "id": "<string>",
                "name": "<string>"
              }
            ],
            "validateByAll": true
          },
          "id": "<string>",
          "kind": "<string>",
          "lastModifiedTime": "2023-11-07T05:31:56Z",
          "propertyData": {
            "personValue": {
              "classId": "<string>",
              "className": "<string>",
              "description": "<string>",
              "displayName": "<string>",
              "displayName_i18n": "<string>",
              "thumbnailPictureUrl": "<string>",
              "value": "<string>"
            },
            "propertyId": "<string>",
            "value": "<string>"
          },
          "propertyTime": "<string>",
          "relativeTime": {
            "after": true,
            "amount": 123,
            "propertyId": "<string>"
          },
          "targetStateId": "<string>",
          "targetStateName": "<string>",
          "targetStateName_i18n": "<string>"
        }
      ]
    }
  ],
  "workflowId": "<string>",
  "workflowName": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://api.aodocs.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

documentId
string
required

The ID of the document

Query Parameters

domain
string

The G Suite domain

securityCode
string

The security code

Response

200 - application/json

A ApiDocumentStateList response

classId
string
className
string
domainName
string
kind
string
libraryId
string
libraryName
string
states
object[]
workflowId
string
workflowName
string