Skip to main content
GET
/
library
/
v1beta1
/
{libId}
/
personFields
cURL
curl --request GET \
  --url https://aodocs.altirnao.com/api/library/v1beta1/{libId}/personFields \
  --header 'Authorization: Bearer <token>'
{
  "documentClassesAndPersonFields": [
    {
      "documentClass": {
        "defaultClass": true,
        "id": "<string>",
        "name": "<string>",
        "name_i18n": "<string>"
      },
      "personFields": [
        {
          "id": "<string>",
          "kind": "<string>",
          "name": "<string>",
          "name_i18n": "<string>",
          "system": true,
          "usedInTransitions": [
            {
              "commentPolicy": "FORBIDDEN",
              "condition": "<string>",
              "fromStateId": "<string>",
              "fromStateName": "<string>",
              "fromStateName_i18n": "<string>",
              "id": "<string>",
              "kind": "<string>",
              "mandatoryComment": true,
              "name": "<string>",
              "name_i18n": "<string>",
              "parallel": true,
              "targetStateId": "<string>",
              "targetStateName": "<string>",
              "targetStateName_i18n": "<string>",
              "validators": [
                {
                  "kind": "<string>",
                  "user": {
                    "email": "<string>",
                    "kind": "<string>",
                    "name": "<string>",
                    "nonGoogle": true,
                    "thumbnailPictureUrl": "<string>"
                  },
                  "validated": true
                }
              ],
              "value": "<string>",
              "workflowId": "<string>"
            }
          ],
          "values": [
            {
              "classId": "<string>",
              "className": "<string>",
              "description": "<string>",
              "displayName": "<string>",
              "displayName_i18n": "<string>",
              "thumbnailPictureUrl": "<string>",
              "type": "USER",
              "value": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "kind": "<string>",
  "systemPersonFields": [
    {
      "id": "<string>",
      "kind": "<string>",
      "name": "<string>",
      "name_i18n": "<string>",
      "system": true,
      "usedInTransitions": [
        {
          "commentPolicy": "FORBIDDEN",
          "condition": "<string>",
          "fromStateId": "<string>",
          "fromStateName": "<string>",
          "fromStateName_i18n": "<string>",
          "id": "<string>",
          "kind": "<string>",
          "mandatoryComment": true,
          "name": "<string>",
          "name_i18n": "<string>",
          "parallel": true,
          "targetStateId": "<string>",
          "targetStateName": "<string>",
          "targetStateName_i18n": "<string>",
          "validators": [
            {
              "kind": "<string>",
              "user": {
                "email": "<string>",
                "kind": "<string>",
                "name": "<string>",
                "nonGoogle": true,
                "thumbnailPictureUrl": "<string>"
              },
              "validated": true
            }
          ],
          "value": "<string>",
          "workflowId": "<string>"
        }
      ],
      "values": [
        {
          "classId": "<string>",
          "className": "<string>",
          "description": "<string>",
          "displayName": "<string>",
          "displayName_i18n": "<string>",
          "thumbnailPictureUrl": "<string>",
          "type": "USER",
          "value": "<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

​
libId
string
required

The ID of the library

Query Parameters

​
classId
string

The ID of the document class

​
documentId
string

The ID of the document

​
includeTransitionUsage
boolean
default:false

Whether the list of transitions in which person fields are referenced (via role in transitions) should be returned

​
domain
string

The G Suite domain

​
securityCode
string

The security code

Response

200 - application/json

A ApiDocumentClassAndPersonFieldsList response

​
documentClassesAndPersonFields
object[]
​
kind
string
​
systemPersonFields
object[]