# AO Docs Documentation ## Docs - [About API resources](https://api.aodocs.com/about-api-resources.md): An AODocs object such as a document or a library is a logical grouping of metadata arranged to serve an organizational purpose. - [Attachment](https://api.aodocs.com/api-reference/attachment.md): Lets you manage document attachments - [Category](https://api.aodocs.com/api-reference/category.md): Lets you manage (list, load, patch, update, add new, delete) categories and category values - [Delete categoryv1libraries categories](https://api.aodocs.com/api-reference/category/delete-categoryv1libraries-categories.md): Deletes a category from the library. - [Delete categoryv1libraries categories values](https://api.aodocs.com/api-reference/category/delete-categoryv1libraries-categories-values.md): Deletes a category value of a category in a library. - [Get categoryv1libraries](https://api.aodocs.com/api-reference/category/get-categoryv1libraries.md): Lists the categories available in a library. - [Get categoryv1libraries categories](https://api.aodocs.com/api-reference/category/get-categoryv1libraries-categories.md): Gets the definition of a category in a library. - [Get categoryv1libraries categories allvalueshierarchy](https://api.aodocs.com/api-reference/category/get-categoryv1libraries-categories-allvalueshierarchy.md): Lists all the values recursively of a category in a library. - [Get categoryv1libraries categories values](https://api.aodocs.com/api-reference/category/get-categoryv1libraries-categories-values.md): Lists the children category values of a parent category value of a category in a library. - [Get categoryv1libraries categories values 1](https://api.aodocs.com/api-reference/category/get-categoryv1libraries-categories-values-1.md): Gets the category value of a category in a library. - [Patch categoryv1](https://api.aodocs.com/api-reference/category/patch-categoryv1.md): Updates a category in the library (keep existing values for not specified fields). - [Patch categoryv1libraries categories values](https://api.aodocs.com/api-reference/category/patch-categoryv1libraries-categories-values.md): Updates a category value of a category in a library. - [Post categoryv1](https://api.aodocs.com/api-reference/category/post-categoryv1.md): Updates a category in the library (reset not specified fields). - [Post categoryv1libraries categories :removeemptysublevels](https://api.aodocs.com/api-reference/category/post-categoryv1libraries-categories-:removeemptysublevels.md): Deletes all empty sublevels of a category. - [Put categoryv1](https://api.aodocs.com/api-reference/category/put-categoryv1.md): Creates a category in the library. - [Put categoryv1libraries categories values](https://api.aodocs.com/api-reference/category/put-categoryv1libraries-categories-values.md): Creates a category value of a category in a library. - [Get viewv1crosslibrary](https://api.aodocs.com/api-reference/crosslibraryview/get-viewv1crosslibrary.md): Gets the cross library view configuration. - [Put viewv1crosslibrary](https://api.aodocs.com/api-reference/crosslibraryview/put-viewv1crosslibrary.md): Updates the cross library view configuration (reset not specified fields). - [Document](https://api.aodocs.com/api-reference/document.md): Manage documents (beta version, subject to change) - [Document Type](https://api.aodocs.com/api-reference/document-type.md): Lets you manipulate existing document classes (beta version, subject to change) - [Document View Config](https://api.aodocs.com/api-reference/document-view-config.md): Lets you configure how documents are presented and edited - [Get documentv2beta1documents states](https://api.aodocs.com/api-reference/document/get-documentv2beta1documents-states.md): Lists the possible states for the document by the current user. - [Get documentv2beta1documents transitions](https://api.aodocs.com/api-reference/document/get-documentv2beta1documents-transitions.md): Lists transitions for the document where the current user is involved. - [Get documentv2beta1documents transitions 1](https://api.aodocs.com/api-reference/document/get-documentv2beta1documents-transitions-1.md): Gets transition for the document where the current user is involved. - [Get documentv2beta1documents transitionshistory](https://api.aodocs.com/api-reference/document/get-documentv2beta1documents-transitionshistory.md): Lists the history of transitions for the document. - [Document ID](https://api.aodocs.com/api-reference/documentid.md): Lets you read and update document properties, create new documents, delete documents, manage document versions, ... (beta version, subject to change) - [Delete documentv1](https://api.aodocs.com/api-reference/documentid/delete-documentv1.md): Deletes a document. - [Delete documentv1 lock](https://api.aodocs.com/api-reference/documentid/delete-documentv1-lock.md): Releases the lock put on a document. - [Delete documentv1beta1 comments](https://api.aodocs.com/api-reference/documentid/delete-documentv1beta1-comments.md): Deletes a comment made outside a workflow context on a document - [Get documentv1](https://api.aodocs.com/api-reference/documentid/get-documentv1.md): Creates a pre-filled unsaved document. - [Get documentv1 1](https://api.aodocs.com/api-reference/documentid/get-documentv1-1.md): Gets a document. - [Get documentv1 version](https://api.aodocs.com/api-reference/documentid/get-documentv1-version.md): Lists past versions of a document. - [Get documentv1 version 1](https://api.aodocs.com/api-reference/documentid/get-documentv1-version-1.md): Gets a past version of a document. - [Get documentv1:listlocked](https://api.aodocs.com/api-reference/documentid/get-documentv1:listlocked.md): List all the active documents with lock in a library. - [Get documentv1beta1 comments](https://api.aodocs.com/api-reference/documentid/get-documentv1beta1-comments.md): Lists the comments put on the document. - [Get documentv1beta1 vieweractions](https://api.aodocs.com/api-reference/documentid/get-documentv1beta1-vieweractions.md): Lists the viewer actions applicable to a document. - [Get documentv1beta1activities](https://api.aodocs.com/api-reference/documentid/get-documentv1beta1activities.md): Lists document activities. - [Get documentv1beta1creation token](https://api.aodocs.com/api-reference/documentid/get-documentv1beta1creation-token.md) - [Get documentv1beta1generateids](https://api.aodocs.com/api-reference/documentid/get-documentv1beta1generateids.md): Generates a set of document IDs which can be provided in insertDocument requests. - [Patch documentv1](https://api.aodocs.com/api-reference/documentid/patch-documentv1.md): Updates a document (keep existing values for not specified fields). - [Patch documentv1beta1 async](https://api.aodocs.com/api-reference/documentid/patch-documentv1beta1-async.md): Updates a document asynchronously (keep existing values for not specified fields). - [Patch documentv1beta1 version](https://api.aodocs.com/api-reference/documentid/patch-documentv1beta1-version.md): [Restricted] Updates a previous version of a document (keep existing values for not specified fields) - [Post documentv1](https://api.aodocs.com/api-reference/documentid/post-documentv1.md): Updates a document (reset not specified fields). - [Post documentv1 copy](https://api.aodocs.com/api-reference/documentid/post-documentv1-copy.md): Copies the given document via a job. The id of the new document created is returned immediately. - [Post documentv1 exporttomydrive](https://api.aodocs.com/api-reference/documentid/post-documentv1-exporttomydrive.md): Exports attachment from a Document Management library to a user's My Drive. - [Post documentv1 lock](https://api.aodocs.com/api-reference/documentid/post-documentv1-lock.md): Locks the document for edition by the current user. - [Post documentv1 move](https://api.aodocs.com/api-reference/documentid/post-documentv1-move.md): Moves a document in the folder tree. - [Post documentv1 notifyusers](https://api.aodocs.com/api-reference/documentid/post-documentv1-notifyusers.md): Sends a formatted email from AODocs to specific users/groups with a subject and content. - [Post documentv1 version](https://api.aodocs.com/api-reference/documentid/post-documentv1-version.md): Restore a previous version of a document by creating a new version based on document content of the chosen past version. - [Post documentv1beta1 attachments](https://api.aodocs.com/api-reference/documentid/post-documentv1beta1-attachments.md): Updates the content of an attachment (in an AODocs document). The new content can come either from an already pushed revision of the Drive file (the latest) or from another file in Drive. When updating the content, the document may be versioned to keep reference to the previous content of the attach… - [Post documentv1beta1 comments](https://api.aodocs.com/api-reference/documentid/post-documentv1beta1-comments.md): Creates a new comment on a document (outside workflow context) - [Post documentv1beta1 vieweractionsvieweractions execute](https://api.aodocs.com/api-reference/documentid/post-documentv1beta1-vieweractionsvieweractions-execute.md): Executes a viewer action applicable to a document. - [Post documentv1beta1calculate](https://api.aodocs.com/api-reference/documentid/post-documentv1beta1calculate.md): Evaluate calculated properties (calculated properties, calculated title, ...) on the document - [Post documentv1createdrivefile](https://api.aodocs.com/api-reference/documentid/post-documentv1createdrivefile.md): Creates a file in the Drive of the storage account of the given library. - [Post documentv1newversionbyattachment](https://api.aodocs.com/api-reference/documentid/post-documentv1newversionbyattachment.md): Creates a new version of the AODocs document after uploading a new revision of an attachment (deprecated, use 'updateAttachment' instead). - [Put documentv1](https://api.aodocs.com/api-reference/documentid/put-documentv1.md): Creates a new document of the given class in the given library. - [Put documentv1 checkin](https://api.aodocs.com/api-reference/documentid/put-documentv1-checkin.md): Checks in a document (commits the draft version's content as a new version of the document - at the end of the potential job). - [Put documentv1 checkout](https://api.aodocs.com/api-reference/documentid/put-documentv1-checkout.md): Checks out a document (creates a draft version of the document - at the end of the potential job). - [Put documentv1 discardcheckout](https://api.aodocs.com/api-reference/documentid/put-documentv1-discardcheckout.md): Discards the check-out of a document (deletes the draft version to come back to the main version as current version). - [Put documentv1 untrash](https://api.aodocs.com/api-reference/documentid/put-documentv1-untrash.md): Restores a document from the trash. - [Put documentv1 version](https://api.aodocs.com/api-reference/documentid/put-documentv1-version.md): Creates a new version of a document. - [Put documentv1beta1](https://api.aodocs.com/api-reference/documentid/put-documentv1beta1.md): Creates a new document with versions. - [Put documentv1beta1 publish](https://api.aodocs.com/api-reference/documentid/put-documentv1beta1-publish.md): Publishes or unpublishes a document's attachments on Drive. - [Put documentv1beta1async](https://api.aodocs.com/api-reference/documentid/put-documentv1beta1async.md): Creates a new document asynchronously (useful in case of numerous attachments) of the given class in the given library. - [Put documentv1beta1asyncwithversions](https://api.aodocs.com/api-reference/documentid/put-documentv1beta1asyncwithversions.md): Creates a new document with versions asynchronously (useful in case of numerous attachments). - [Delete documenttypev1beta1libraries documenttypes templatedocuments](https://api.aodocs.com/api-reference/documenttype/delete-documenttypev1beta1libraries-documenttypes-templatedocuments.md): Deletes a document template. - [Delete documenttypev1libraries documenttypes](https://api.aodocs.com/api-reference/documenttype/delete-documenttypev1libraries-documenttypes.md): Deletes a document class. - [Get documenttypev1beta1libraries documenttypes templatedocuments](https://api.aodocs.com/api-reference/documenttype/get-documenttypev1beta1libraries-documenttypes-templatedocuments.md): Lists the full content of the document templates of the given class in the library. - [Get documenttypev1beta1libraries documenttypes templatedocuments 1](https://api.aodocs.com/api-reference/documenttype/get-documenttypev1beta1libraries-documenttypes-templatedocuments-1.md): Gets the configuration of a document template. - [Get documenttypev1libraries](https://api.aodocs.com/api-reference/documenttype/get-documenttypev1libraries.md): Lists the ID/name of the document classes in a library. - [Get documenttypev1libraries documenttypes](https://api.aodocs.com/api-reference/documenttype/get-documenttypev1libraries-documenttypes.md): Gets the configuration of a document class. - [Patch documenttypev1beta1libraries documenttypes templatedocuments](https://api.aodocs.com/api-reference/documenttype/patch-documenttypev1beta1libraries-documenttypes-templatedocuments.md): Updates a document template configuration. - [Patch documenttypev1libraries documenttypes](https://api.aodocs.com/api-reference/documenttype/patch-documenttypev1libraries-documenttypes.md): Updates a document class configuration (keep existing values for not specified fields). - [Post documenttypev1libraries documenttypes](https://api.aodocs.com/api-reference/documenttype/post-documenttypev1libraries-documenttypes.md): Creates a new document class in the library. - [Put documenttypev1beta1libraries documenttypes templatedocuments](https://api.aodocs.com/api-reference/documenttype/put-documenttypev1beta1libraries-documenttypes-templatedocuments.md): Creates a new document template of a class in the library. - [Put documenttypev1libraries documenttypes](https://api.aodocs.com/api-reference/documenttype/put-documenttypev1libraries-documenttypes.md): Updates a document class configuration (reset not specified fields). - [Get documentviewconfigv1library documenttype](https://api.aodocs.com/api-reference/documentviewconfig/get-documentviewconfigv1library-documenttype.md): Gets the document view configuration related to a document class. - [Put documentviewconfigv1library documenttype](https://api.aodocs.com/api-reference/documentviewconfig/put-documentviewconfigv1library-documenttype.md): Sets the document view configuration of a document class (orientation, sections displayed...). - [Domain](https://api.aodocs.com/api-reference/domain.md): Lets you manage (list, load, patch, update, add new, delete) domain settings (beta version, subject to change) - [Delete domainv1beta1configuration](https://api.aodocs.com/api-reference/domain/delete-domainv1beta1configuration.md): Deletes the specified custom configuration flag at domain level. - [Delete domainv1beta1licensedusers](https://api.aodocs.com/api-reference/domain/delete-domainv1beta1licensedusers.md): Deletes licensed user(s) from the domain. - [Delete domainv1beta1roles](https://api.aodocs.com/api-reference/domain/delete-domainv1beta1roles.md): Deletes a domain role. - [Delete domainv1beta1securitycodes](https://api.aodocs.com/api-reference/domain/delete-domainv1beta1securitycodes.md): Deletes a security code from the domain. - [Delete domainv1beta1storageaccounts](https://api.aodocs.com/api-reference/domain/delete-domainv1beta1storageaccounts.md): Deletes a storage account from the domain. - [Get domainv1auditlog](https://api.aodocs.com/api-reference/domain/get-domainv1auditlog.md): Lists the audit log events relative to specified filters. - [Get domainv1beta1](https://api.aodocs.com/api-reference/domain/get-domainv1beta1.md): Gets information about the domain. - [Get domainv1beta1billingstatus](https://api.aodocs.com/api-reference/domain/get-domainv1beta1billingstatus.md): Gets billing status of the domain. - [Get domainv1beta1configuration](https://api.aodocs.com/api-reference/domain/get-domainv1beta1configuration.md): Gets all custom domain configuration flags defined at domain level. - [Get domainv1beta1configurationflags](https://api.aodocs.com/api-reference/domain/get-domainv1beta1configurationflags.md): Gets the custom domain configurations with fallback on default value. - [Get domainv1beta1expiredlicenseusers](https://api.aodocs.com/api-reference/domain/get-domainv1beta1expiredlicenseusers.md): Lists the users of the domain, whose license expired. (DEPRECATED : Use licensedUsers with status=EXPIRED instead). - [Get domainv1beta1licensedusers](https://api.aodocs.com/api-reference/domain/get-domainv1beta1licensedusers.md): Lists the licensed users of the domain. - [Get domainv1beta1licensedusers 1](https://api.aodocs.com/api-reference/domain/get-domainv1beta1licensedusers-1.md): Gets a licensed user of the domain by email. - [Get domainv1beta1roles](https://api.aodocs.com/api-reference/domain/get-domainv1beta1roles.md): Lists the domain roles. - [Get domainv1beta1roles 1](https://api.aodocs.com/api-reference/domain/get-domainv1beta1roles-1.md): Gets a domain role. - [Get domainv1beta1securitycodes](https://api.aodocs.com/api-reference/domain/get-domainv1beta1securitycodes.md): Lists the security codes of the domain. - [Get domainv1beta1standardactions](https://api.aodocs.com/api-reference/domain/get-domainv1beta1standardactions.md): Gets the list of available standard actions for the current domain (Coming soon! This method isn't yet available. It will be made available in a future release). - [Get domainv1beta1statistics](https://api.aodocs.com/api-reference/domain/get-domainv1beta1statistics.md): Lists statistics for a specified entity (domain, storage account or library). The pagination only works for the library statistics. - [Get domainv1beta1statistics ](https://api.aodocs.com/api-reference/domain/get-domainv1beta1statistics-.md): Gets statistics for a specified entity (domain, storage account or library). - [Get domainv1beta1storageaccounts](https://api.aodocs.com/api-reference/domain/get-domainv1beta1storageaccounts.md): Lists storage accounts. - [Get domainv1beta1storageaccounts 1](https://api.aodocs.com/api-reference/domain/get-domainv1beta1storageaccounts-1.md): Gets the storage account by email. - [Get domainv1check](https://api.aodocs.com/api-reference/domain/get-domainv1check.md): Checks the status of the domain. - [Get domainv1storageadmins](https://api.aodocs.com/api-reference/domain/get-domainv1storageadmins.md): Lists the storage accounts of the domain. - [Patch domainv1beta1](https://api.aodocs.com/api-reference/domain/patch-domainv1beta1.md): Updates domain configurations. - [Patch domainv1beta1billingstatus](https://api.aodocs.com/api-reference/domain/patch-domainv1beta1billingstatus.md): Updates billing status of the domain. - [Patch domainv1beta1roles](https://api.aodocs.com/api-reference/domain/patch-domainv1beta1roles.md): Updates a domain role (keep existing values for not specified fields). - [Patch domainv1beta1securitycodes](https://api.aodocs.com/api-reference/domain/patch-domainv1beta1securitycodes.md): Updates a security code on the domain. - [Patch domainv1beta1storageaccounts](https://api.aodocs.com/api-reference/domain/patch-domainv1beta1storageaccounts.md): Updates a storage account on the domain. - [Post domainv1beta1configuration](https://api.aodocs.com/api-reference/domain/post-domainv1beta1configuration.md): Updates values of domain level custom configuration flags. Unspecified flags previously defined at domain level will be deleted! - [Post domainv1beta1configuration 1](https://api.aodocs.com/api-reference/domain/post-domainv1beta1configuration-1.md): Sets value for the specified custom configuration flag at domain level. - [Post domainv1beta1image](https://api.aodocs.com/api-reference/domain/post-domainv1beta1image.md): Method to call before uploading an image to AODocs. The images are visible to the users who can access the library and if present the document. - [Post domainv1beta1licensedusersbatchdelete](https://api.aodocs.com/api-reference/domain/post-domainv1beta1licensedusersbatchdelete.md): Deletes licensed user(s) from the domain. - [Post domainv1beta1roles](https://api.aodocs.com/api-reference/domain/post-domainv1beta1roles.md): Creates a new domain role. - [Post domainv1beta1securitycodes](https://api.aodocs.com/api-reference/domain/post-domainv1beta1securitycodes.md): Creates a security code on the domain. - [Post domainv1beta1storageaccounts](https://api.aodocs.com/api-reference/domain/post-domainv1beta1storageaccounts.md): Creates a storage account for the domain. - [Put domainv1activate](https://api.aodocs.com/api-reference/domain/put-domainv1activate.md): Activates the domain on AODocs. - [Put domainv1beta1licensedusers](https://api.aodocs.com/api-reference/domain/put-domainv1beta1licensedusers.md): Pre-allocates licenses to user - [Put domainv1beta1licensedusersbatchallocate](https://api.aodocs.com/api-reference/domain/put-domainv1beta1licensedusersbatchallocate.md): Pre-allocates licenses to user - [Put domainv1register ](https://api.aodocs.com/api-reference/domain/put-domainv1register-.md): Registers the domain on AODocs. - [Get library classid documentid attachmentid checkxref](https://api.aodocs.com/api-reference/drawing/get-library-classid-documentid-attachmentid-checkxref.md): ################################### - [Drive Import](https://api.aodocs.com/api-reference/driveImport.md): Lets you import files and manage imported files - [Drive ID](https://api.aodocs.com/api-reference/driveid.md): Lets you read and update document properties, create new documents, delete documents, manage document versions, ... (beta version, subject to change) - [Delete documentv1drive](https://api.aodocs.com/api-reference/driveid/delete-documentv1drive.md): Deletes a document AODocs via the Drive ID of one of its attachment. - [Delete documentv1drive lock](https://api.aodocs.com/api-reference/driveid/delete-documentv1drive-lock.md): Releases the lock put on a document via the Drive ID of one of its attachment. - [Get documentv1](https://api.aodocs.com/api-reference/driveid/get-documentv1.md): Creates a pre-filled unsaved document. - [Get documentv1beta1drive revision revisionlink](https://api.aodocs.com/api-reference/driveid/get-documentv1beta1drive-revision-revisionlink.md): Gets the url of a revision of a Drive file. - [Get documentv1beta1drive revision storagelink](https://api.aodocs.com/api-reference/driveid/get-documentv1beta1drive-revision-storagelink.md): Gets the url of a revision of a Drive file. - [Get documentv1drive](https://api.aodocs.com/api-reference/driveid/get-documentv1drive.md): Gets a document AODocs via the Drive ID of one of its attachment. - [Get documentv1drive permission](https://api.aodocs.com/api-reference/driveid/get-documentv1drive-permission.md): Lists the permissions applied on a Drive file. - [Get documentv1drive version](https://api.aodocs.com/api-reference/driveid/get-documentv1drive-version.md): Lists past versions of a document via the Drive ID of one of its attachment. - [Get documentv1drive version 1](https://api.aodocs.com/api-reference/driveid/get-documentv1drive-version-1.md): Gets a past version of a document via the Drive ID of one of its attachment. - [Get documentv1drive webdav](https://api.aodocs.com/api-reference/driveid/get-documentv1drive-webdav.md): Gets the link to open the file with the Webdav. - [Patch documentv1drive](https://api.aodocs.com/api-reference/driveid/patch-documentv1drive.md): Updates a document AODocs via the Drive ID of one of its attachment (keep existing values for not specified fields). - [Post documentv1createdrivefile](https://api.aodocs.com/api-reference/driveid/post-documentv1createdrivefile.md): Creates a file in the Drive of the storage account of the given library. - [Post documentv1drive](https://api.aodocs.com/api-reference/driveid/post-documentv1drive.md): Updates a document AODocs via the Drive ID of one of its attachment (reset not specified fields). - [Post documentv1drive check](https://api.aodocs.com/api-reference/driveid/post-documentv1drive-check.md): Checks if the Drive file is attached to a document AODocs. - [Post documentv1drive copy](https://api.aodocs.com/api-reference/driveid/post-documentv1drive-copy.md): Copies the given document (via the Drive ID of one of its attachment) via a job. The id of the new document created is returned immediately. - [Post documentv1drive lock](https://api.aodocs.com/api-reference/driveid/post-documentv1drive-lock.md): Locks the document (via the Drive ID of one of its attachment) for edition by the current user. - [Post documentv1drive move](https://api.aodocs.com/api-reference/driveid/post-documentv1drive-move.md): Moves a document AODocs via the Drive ID of one of its attachment in the folder tree. - [Post documentv1drive permission](https://api.aodocs.com/api-reference/driveid/post-documentv1drive-permission.md): Updates the permissions applied on a Drive file. - [Post documentv1drive version](https://api.aodocs.com/api-reference/driveid/post-documentv1drive-version.md): Restore a previous version of a document (via the Drive ID of one of its attachment) by creating a new version based on document content of the chosen past version. - [Post documentv1drivenative](https://api.aodocs.com/api-reference/driveid/post-documentv1drivenative.md): Creates a native file in the Drive of the storage account of the given library. - [Post documentv1newversionbyattachment](https://api.aodocs.com/api-reference/driveid/post-documentv1newversionbyattachment.md): Creates a new version of the AODocs document after uploading a new revision of an attachment (deprecated, use 'updateAttachment' instead). - [Put documentv1](https://api.aodocs.com/api-reference/driveid/put-documentv1.md): Creates a new document of the given class in the given library. - [Put documentv1drive checkin](https://api.aodocs.com/api-reference/driveid/put-documentv1drive-checkin.md): Checks in a document via the Drive ID of one of its attachment (commits the draft version's content as a new version of the document - at the end of the potential job). - [Put documentv1drive checkout](https://api.aodocs.com/api-reference/driveid/put-documentv1drive-checkout.md): Checks out a document via the Drive ID of one of its attachment (creates a draft version of the document - at the end of the potential job). - [Put documentv1drive discardcheckout](https://api.aodocs.com/api-reference/driveid/put-documentv1drive-discardcheckout.md): Discards the check-out of a document via the Drive ID of one of its attachment (deletes the draft version to come back to the main version as current version). - [Put documentv1drive untrash](https://api.aodocs.com/api-reference/driveid/put-documentv1drive-untrash.md): Restores a document (via the Drive ID of one of its attachment) from the trash. - [Put documentv1drive version](https://api.aodocs.com/api-reference/driveid/put-documentv1drive-version.md): Creates a new version of a document via the Drive ID of one of its attachment. - [Get driveimportv1imports](https://api.aodocs.com/api-reference/driveimport/get-driveimportv1imports.md): Lists the high-level status of the import jobs on the domain. - [Get driveimportv1imports 1](https://api.aodocs.com/api-reference/driveimport/get-driveimportv1imports-1.md): Gets the details of an import job on the domain. - [Get driveimportv1imports files](https://api.aodocs.com/api-reference/driveimport/get-driveimportv1imports-files.md): Lists the details by file of an import job on the domain. - [Post driveimportv1driveimportv1importsupload](https://api.aodocs.com/api-reference/driveimport/post-driveimportv1driveimportv1importsupload.md): Returns a Drive file upload URL with a matching file id. - [Put driveimportv1importsbatchfolders](https://api.aodocs.com/api-reference/driveimport/put-driveimportv1importsbatchfolders.md): Imports several files in a folder managed by AODocs. - [Put driveimportv1importsfolders ](https://api.aodocs.com/api-reference/driveimport/put-driveimportv1importsfolders-.md): Imports a single file in a folder managed by AODocs. It's recommended to use importFileOrFolders instead (to follow-up the job). - [Folder](https://api.aodocs.com/api-reference/folder.md): Lets you list existing folders, update folders, create new folders, ... - [Delete folderv1files](https://api.aodocs.com/api-reference/folder/delete-folderv1files.md): Removes folder with id folderId according to deleteMode - [Delete folderv1libraries folders](https://api.aodocs.com/api-reference/folder/delete-folderv1libraries-folders.md): (Deprecated - use remove) Removes folder with id folderAodocsId in library libraryId according to deleteMode - [Get folderv1files](https://api.aodocs.com/api-reference/folder/get-folderv1files.md): Gets a folder - [Get folderv1files children](https://api.aodocs.com/api-reference/folder/get-folderv1files-children.md): List folders under folder with id folderId, possible loading only direct children - [Get folderv1folders extendedpermissions](https://api.aodocs.com/api-reference/folder/get-folderv1folders-extendedpermissions.md): Loads folder permissions and related flags in Secured Folder and Document Management libraries - [Get folderv1folders hierarchy](https://api.aodocs.com/api-reference/folder/get-folderv1folders-hierarchy.md): Load necessary folders to display selectedFolder in the context of displayRootFolder - [Get folderv1folders permissions](https://api.aodocs.com/api-reference/folder/get-folderv1folders-permissions.md) - [Get folderv1foldertrees](https://api.aodocs.com/api-reference/folder/get-folderv1foldertrees.md): Load necessary folders as trees to display selectedFolder in the context of displayRootFolder applying filter from the view - [Get folderv1libraries](https://api.aodocs.com/api-reference/folder/get-folderv1libraries.md) - [Get folderv1libraries folders](https://api.aodocs.com/api-reference/folder/get-folderv1libraries-folders.md): (DO NOT USE - use list/listFromDisplayRoot) Loads all folders in a library. WARNING! This method can be very inefficient, prefer listFolders/listFoldersFromDisplayRoot methods. - [Get folderv1libraries folders 1](https://api.aodocs.com/api-reference/folder/get-folderv1libraries-folders-1.md): (Deprecated - use get) Loads folder with id folderAodocsId in library libraryId - [Get folderv1libraries foldersanddocuments](https://api.aodocs.com/api-reference/folder/get-folderv1libraries-foldersanddocuments.md): Loads trashed folders and documents in folder with id referenceFolderId - [Get folderv1libraries folderschildren](https://api.aodocs.com/api-reference/folder/get-folderv1libraries-folderschildren.md): (DO NOT USE - use list) List folders under folder with id folderAodocsId, possible loading only direct children - [Patch folderv1](https://api.aodocs.com/api-reference/folder/patch-folderv1.md) - [Post folderv1](https://api.aodocs.com/api-reference/folder/post-folderv1.md) - [Post folderv1duplicate ](https://api.aodocs.com/api-reference/folder/post-folderv1duplicate-.md) - [Post folderv1files](https://api.aodocs.com/api-reference/folder/post-folderv1files.md): Renames a folder - [Post folderv1folders applypermissionsrecursively](https://api.aodocs.com/api-reference/folder/post-folderv1folders-applypermissionsrecursively.md): Applies the permissions of the provided folder to its content recursively - [Post folderv1folders checkfolder](https://api.aodocs.com/api-reference/folder/post-folderv1folders-checkfolder.md) - [Post folderv1folders extendedpermissions](https://api.aodocs.com/api-reference/folder/post-folderv1folders-extendedpermissions.md): Updates folder permissions and related flags in Secured Folder and Document Management libraries - [Post folderv1folders move](https://api.aodocs.com/api-reference/folder/post-folderv1folders-move.md): Moves folder with id folderId to folder parentId (must be in the same library) - [Post folderv1folders permissions](https://api.aodocs.com/api-reference/folder/post-folderv1folders-permissions.md) - [Post folderv1folders untrash](https://api.aodocs.com/api-reference/folder/post-folderv1folders-untrash.md): Restores folder with id folderId from trash into folder targetFolderId. - [Post folderv1libraries folders](https://api.aodocs.com/api-reference/folder/post-folderv1libraries-folders.md): (Deprecated - use rename) Renames folder with id folderAodocsId - [Post folderv1libraries foldersanddocumentsmove](https://api.aodocs.com/api-reference/folder/post-folderv1libraries-foldersanddocumentsmove.md): Moves multiple folders and documents into the parent folder - [Post folderv1libraries foldersanddocumentstrash](https://api.aodocs.com/api-reference/folder/post-folderv1libraries-foldersanddocumentstrash.md): Removes multiple folders and documents according to deleteMode - [Post folderv1libraries foldersanddocumentsuntrash](https://api.aodocs.com/api-reference/folder/post-folderv1libraries-foldersanddocumentsuntrash.md): Restores multiple folders and documents from trash into folder targetFolderId. - [Put folderv1files](https://api.aodocs.com/api-reference/folder/put-folderv1files.md): Creates a folder - [Put folderv1libraries folders](https://api.aodocs.com/api-reference/folder/put-folderv1libraries-folders.md): (Deprecated - use create) Creates a folder in library libraryId with parent parentFolderAodocsId - [Introduction](https://api.aodocs.com/api-reference/introduction.md): The AODocs REST API exposes most of the features of AODocs. It can be used to implement custom applications, third-party integration, bulk tools, or just to experiment with AODocs. - [Job](https://api.aodocs.com/api-reference/job.md): Lets you access information about jobs and cancel them. - [Get jobv1](https://api.aodocs.com/api-reference/job/get-jobv1.md): Gets job details - [Get jobv1events](https://api.aodocs.com/api-reference/job/get-jobv1events.md): Lists the events associated to a job - [Get jobv1libraries](https://api.aodocs.com/api-reference/job/get-jobv1libraries.md): Lists jobs in the library matching some filter and sort criteria - [Post jobv1 cancel](https://api.aodocs.com/api-reference/job/post-jobv1-cancel.md): Cancels a job (only for library administrators) - [Library](https://api.aodocs.com/api-reference/library.md): Lets you list existing libraries, create new libraries, get storage account e-mail (beta version, subject to change) - [Delete libraryv1](https://api.aodocs.com/api-reference/library/delete-libraryv1.md): Deletes a library from the domain. - [Delete libraryv1 categoryvaluemappings](https://api.aodocs.com/api-reference/library/delete-libraryv1-categoryvaluemappings.md): Deletes a category value mapping. - [Delete libraryv1beta1 configuration](https://api.aodocs.com/api-reference/library/delete-libraryv1beta1-configuration.md): Deletes the specified custom configuration flag at library level. - [Delete libraryv1beta1 customscripts](https://api.aodocs.com/api-reference/library/delete-libraryv1beta1-customscripts.md): Deletes a custom script. - [Delete libraryv1beta1 customuiactions](https://api.aodocs.com/api-reference/library/delete-libraryv1beta1-customuiactions.md): Deletes a custom ui action. - [Delete libraryv1beta1 inboundemails](https://api.aodocs.com/api-reference/library/delete-libraryv1beta1-inboundemails.md): Deletes an inbound address. - [Delete libraryv1beta1 lock](https://api.aodocs.com/api-reference/library/delete-libraryv1beta1-lock.md): [Restricted] Release library-level document lock of a library - [Delete libraryv1beta1 roles](https://api.aodocs.com/api-reference/library/delete-libraryv1beta1-roles.md): Deletes a role from the library. - [Delete libraryv1beta1 workflowemails](https://api.aodocs.com/api-reference/library/delete-libraryv1beta1-workflowemails.md): Deletes a workflow email. - [Get libraryv1](https://api.aodocs.com/api-reference/library/get-libraryv1.md): Gets a library. - [Get libraryv1 categoryvaluemappings](https://api.aodocs.com/api-reference/library/get-libraryv1-categoryvaluemappings.md): Lists all category value mappings in the library. - [Get libraryv1 categoryvaluemappings 1](https://api.aodocs.com/api-reference/library/get-libraryv1-categoryvaluemappings-1.md): Gets a category value mapping by ID. - [Get libraryv1 categoryvaluemappings targets](https://api.aodocs.com/api-reference/library/get-libraryv1-categoryvaluemappings-targets.md): Returns the target category values mapped to a given source value. - [Get libraryv1 permission](https://api.aodocs.com/api-reference/library/get-libraryv1-permission.md): Lists library permissions. - [Get libraryv1beta1 classesandtemplates](https://api.aodocs.com/api-reference/library/get-libraryv1beta1-classesandtemplates.md): Lists the classes and templates the current user can create document from (in the library). - [Get libraryv1beta1 configuration](https://api.aodocs.com/api-reference/library/get-libraryv1beta1-configuration.md): Gets all custom configuration flags activated at domain or library level. - [Get libraryv1beta1 configurationflags](https://api.aodocs.com/api-reference/library/get-libraryv1beta1-configurationflags.md): Gets the custom configurations of a library with fallback on default value. - [Get libraryv1beta1 customscripts](https://api.aodocs.com/api-reference/library/get-libraryv1beta1-customscripts.md): Lists all custom scripts. - [Get libraryv1beta1 customscripts 1](https://api.aodocs.com/api-reference/library/get-libraryv1beta1-customscripts-1.md): Gets a custom script by id. - [Get libraryv1beta1 customuiactions](https://api.aodocs.com/api-reference/library/get-libraryv1beta1-customuiactions.md): Lists all custom ui actions. - [Get libraryv1beta1 customuiactions 1](https://api.aodocs.com/api-reference/library/get-libraryv1beta1-customuiactions-1.md): Gets a custom ui action by id. - [Get libraryv1beta1 glossary](https://api.aodocs.com/api-reference/library/get-libraryv1beta1-glossary.md): Gets the glossary of a library. - [Get libraryv1beta1 inboundemails](https://api.aodocs.com/api-reference/library/get-libraryv1beta1-inboundemails.md): Lists all inbound emails in a library. - [Get libraryv1beta1 inboundemails 1](https://api.aodocs.com/api-reference/library/get-libraryv1beta1-inboundemails-1.md): Gets an inbound email by id. - [Get libraryv1beta1 personfields](https://api.aodocs.com/api-reference/library/get-libraryv1beta1-personfields.md): Lists the person fields information used in every document class in the library. If documentId is set, the response will contain person fields' values. - [Get libraryv1beta1 roles](https://api.aodocs.com/api-reference/library/get-libraryv1beta1-roles.md): Lists the roles of the library. - [Get libraryv1beta1 roles 1](https://api.aodocs.com/api-reference/library/get-libraryv1beta1-roles-1.md): Gets a role of the library. - [Get libraryv1beta1 standardactions](https://api.aodocs.com/api-reference/library/get-libraryv1beta1-standardactions.md): List the standard actions. - [Get libraryv1beta1 standardactions 1](https://api.aodocs.com/api-reference/library/get-libraryv1beta1-standardactions-1.md): Gets a standard action of the library by id. - [Get libraryv1beta1 workflowemails](https://api.aodocs.com/api-reference/library/get-libraryv1beta1-workflowemails.md): Lists all workflow emails in a library. - [Get libraryv1beta1 workflowemails 1](https://api.aodocs.com/api-reference/library/get-libraryv1beta1-workflowemails-1.md): Gets a workflow email by id. - [Get libraryv2beta1search](https://api.aodocs.com/api-reference/library/get-libraryv2beta1search.md): List and search libraries in the domain - [Get libraryv2beta1searcharchived](https://api.aodocs.com/api-reference/library/get-libraryv2beta1searcharchived.md): List and search archive libraries in the domain - [Get libraryv2beta1suggest](https://api.aodocs.com/api-reference/library/get-libraryv2beta1suggest.md): Suggest libraries from the domain - [Patch libraryv1](https://api.aodocs.com/api-reference/library/patch-libraryv1.md): Updates a library (keep existing values for not specified fields). - [Patch libraryv1beta1 :privilegedupdate](https://api.aodocs.com/api-reference/library/patch-libraryv1beta1-:privilegedupdate.md): [Restricted] Updates a library (keep existing values for not specified fields), including the object storage location and the attachment search engine. - [Patch libraryv1beta1 customuiactions](https://api.aodocs.com/api-reference/library/patch-libraryv1beta1-customuiactions.md): Patches an existing custom ui action. - [Patch libraryv1beta1 inboundemails](https://api.aodocs.com/api-reference/library/patch-libraryv1beta1-inboundemails.md): Updates an inbound address with patch semantics. - [Patch libraryv1beta1 roles](https://api.aodocs.com/api-reference/library/patch-libraryv1beta1-roles.md): Updates a role of the library (keep existing values for not specified fields). - [Patch libraryv1beta1 standardactions](https://api.aodocs.com/api-reference/library/patch-libraryv1beta1-standardactions.md): Updates a standard action (keeps existing values for not specified fields). - [Patch libraryv1beta1 workflowemails](https://api.aodocs.com/api-reference/library/patch-libraryv1beta1-workflowemails.md): Updates a workflow email with patch semantics. - [Post libraryv1 categoryvaluemappings](https://api.aodocs.com/api-reference/library/post-libraryv1-categoryvaluemappings.md): Creates a new category value mapping between two category definitions in the library. - [Post libraryv1 permission](https://api.aodocs.com/api-reference/library/post-libraryv1-permission.md): Updates library permissions. - [Post libraryv1beta1 changeattachmentmode](https://api.aodocs.com/api-reference/library/post-libraryv1beta1-changeattachmentmode.md): [Restricted] Modifies the attachment mode of a library. It can only be from a Team Folder or a Secured Folder to a Document Management Library. - [Post libraryv1beta1 configuration](https://api.aodocs.com/api-reference/library/post-libraryv1beta1-configuration.md): Updates values of library level custom configuration flags. Unspecified flags previously defined at library level will be deleted! - [Post libraryv1beta1 configuration 1](https://api.aodocs.com/api-reference/library/post-libraryv1beta1-configuration-1.md): Sets value for the specified custom configuration flag at library level. - [Post libraryv1beta1 customscripts](https://api.aodocs.com/api-reference/library/post-libraryv1beta1-customscripts.md): Creates a new custom script. - [Post libraryv1beta1 customscripts:compile](https://api.aodocs.com/api-reference/library/post-libraryv1beta1-customscripts:compile.md): Compiles a custom script and returns with its outcome. - [Post libraryv1beta1 customuiactions](https://api.aodocs.com/api-reference/library/post-libraryv1beta1-customuiactions.md): Creates a new custom ui action. - [Post libraryv1beta1 exportdocumentsandfolders](https://api.aodocs.com/api-reference/library/post-libraryv1beta1-exportdocumentsandfolders.md): Exports documents and/or folders from the library. - [Post libraryv1beta1 glossary](https://api.aodocs.com/api-reference/library/post-libraryv1beta1-glossary.md): Sets the new glossary of a library. - [Post libraryv1beta1 inboundemails](https://api.aodocs.com/api-reference/library/post-libraryv1beta1-inboundemails.md): Creates an inbound address for a library. - [Post libraryv1beta1 lock](https://api.aodocs.com/api-reference/library/post-libraryv1beta1-lock.md): [Restricted] Create library-level document lock on a library, automatic operations are suspended - [Post libraryv1beta1 roles](https://api.aodocs.com/api-reference/library/post-libraryv1beta1-roles.md): Creates a new role in the library. - [Post libraryv1beta1 workflowemails](https://api.aodocs.com/api-reference/library/post-libraryv1beta1-workflowemails.md): Creates a workflow email for a library. - [Post libraryv1library](https://api.aodocs.com/api-reference/library/post-libraryv1library.md): [Restricted] Creates a library on the domain. - [Post libraryv1library 1](https://api.aodocs.com/api-reference/library/post-libraryv1library-1.md): Creates a library on the domain. - [Put libraryv1](https://api.aodocs.com/api-reference/library/put-libraryv1.md): Lists libraries of the domain. - [Put libraryv1 1](https://api.aodocs.com/api-reference/library/put-libraryv1-1.md): Updates a library (reset not specified fields). - [Put libraryv1 categoryvaluemappings](https://api.aodocs.com/api-reference/library/put-libraryv1-categoryvaluemappings.md): Updates the display name and entries of a category value mapping. Other fields are read-only. - [Put libraryv1beta1 customscripts](https://api.aodocs.com/api-reference/library/put-libraryv1beta1-customscripts.md): Updates an existing custom script. - [Put libraryv1plain](https://api.aodocs.com/api-reference/library/put-libraryv1plain.md): Lists libraries of the domain (only ID-name pairs). - [Reference Catalog](https://api.aodocs.com/api-reference/reference-catalog.md): Lets you manage reference catalogs - [Delete referencecatalogv1](https://api.aodocs.com/api-reference/referencecatalog/delete-referencecatalogv1.md): Deletes a reference catalog in the domain. - [Delete referencecatalogv1 items](https://api.aodocs.com/api-reference/referencecatalog/delete-referencecatalogv1-items.md): Permanently deletes a value of a reference catalog in the domain. - [Get referencecatalogv1](https://api.aodocs.com/api-reference/referencecatalog/get-referencecatalogv1.md): Lists the reference catalogs available in the domain. - [Get referencecatalogv1 1](https://api.aodocs.com/api-reference/referencecatalog/get-referencecatalogv1-1.md): Gets a reference catalog in the domain. - [Get referencecatalogv1 items](https://api.aodocs.com/api-reference/referencecatalog/get-referencecatalogv1-items.md): Lists the values of a reference catalog in the domain. - [Get referencecatalogv1 items 1](https://api.aodocs.com/api-reference/referencecatalog/get-referencecatalogv1-items-1.md): Gets a value of a reference catalog in the domain. - [Get referencecatalogv1 suggest](https://api.aodocs.com/api-reference/referencecatalog/get-referencecatalogv1-suggest.md): Lists suggested matching values of a reference catalog in the domain. - [Post referencecatalogv1](https://api.aodocs.com/api-reference/referencecatalog/post-referencecatalogv1.md): Updates a reference catalog in the domain. - [Post referencecatalogv1 items](https://api.aodocs.com/api-reference/referencecatalog/post-referencecatalogv1-items.md): Creates, updates or marked 'deleted' a list of values of a reference catalog in the domain. - [Put referencecatalogv1](https://api.aodocs.com/api-reference/referencecatalog/put-referencecatalogv1.md): Creates a reference catalog in the domain. - [Relation](https://api.aodocs.com/api-reference/relation.md): Lets you list AODocs document relations - [Delete relationv1beta1relationdefinitions](https://api.aodocs.com/api-reference/relation/delete-relationv1beta1relationdefinitions.md): Deletes a relation definition by id. - [Get relationv1beta1document relation](https://api.aodocs.com/api-reference/relation/get-relationv1beta1document-relation.md): Lists all related documents for a document. - [Get relationv1beta1relationdefinitions](https://api.aodocs.com/api-reference/relation/get-relationv1beta1relationdefinitions.md): Lists relation definitions for a library or a document class. - [Get relationv1beta1relationdefinitions 1](https://api.aodocs.com/api-reference/relation/get-relationv1beta1relationdefinitions-1.md): Gets a relation definition by id. - [Get relationv1document](https://api.aodocs.com/api-reference/relation/get-relationv1document.md): Lists all related documents for a document. - [Get relationv1libraries relations documents](https://api.aodocs.com/api-reference/relation/get-relationv1libraries-relations-documents.md): Lists all related documents for a document and a relation. - [Get relationv1relations side documents](https://api.aodocs.com/api-reference/relation/get-relationv1relations-side-documents.md): Lists all documents that can be linked for a relation. - [Get relationv1relations side documents 1](https://api.aodocs.com/api-reference/relation/get-relationv1relations-side-documents-1.md): Lists all documents that can be linked to a document for a relation. - [Patch relationv1beta1relationdefinitions](https://api.aodocs.com/api-reference/relation/patch-relationv1beta1relationdefinitions.md): Updates a relation definition with patch semantics. - [Post relationv1beta1relationdefinitions](https://api.aodocs.com/api-reference/relation/post-relationv1beta1relationdefinitions.md): Creates a relation definition. - [Post relationv1document](https://api.aodocs.com/api-reference/relation/post-relationv1document.md): Updates related documents for a document. - [Search](https://api.aodocs.com/api-reference/search.md): Lets you search and count documents - [Post searchv1document](https://api.aodocs.com/api-reference/search/post-searchv1document.md): Searches documents in the whole domain matching the provided query. - [Post searchv1domain](https://api.aodocs.com/api-reference/search/post-searchv1domain.md): Searches documents in the domain with attachments matching the search query. The document metadata will not be searched using this method. - [Post searchv1filterableproperties](https://api.aodocs.com/api-reference/search/post-searchv1filterableproperties.md): Lists all filterable properties available in the domain for document search. - [Post searchv1libraries count](https://api.aodocs.com/api-reference/search/post-searchv1libraries-count.md): Counts documents of a document class. Only accessible to library administrators. - [Post searchv1libraries list](https://api.aodocs.com/api-reference/search/post-searchv1libraries-list.md): Lists all documents of a document class. Only accessible to library administrators. - [Post searchv1libraries search](https://api.aodocs.com/api-reference/search/post-searchv1libraries-search.md): Searches documents of a class matching the provided query. Might become very slow or timeout when iterating over many results pages. If the result set contains more than 10k documents, it's highly likely some results will be missing. You should always check if precision=INCOMPLETE_RESULT in the resp… - [Post searchv1libraries searchdrive](https://api.aodocs.com/api-reference/search/post-searchv1libraries-searchdrive.md): Starts to cache search results asynchronously in a job. Returns the jobId. - [Post searchv1libraries views](https://api.aodocs.com/api-reference/search/post-searchv1libraries-views.md): Searches documents in a view matching the provided query. Might become very slow or timeout when iterating over many results pages. If the result set contains more than 10k documents, it's highly likely some results will be missing. You should always check if precision=INCOMPLETE_RESULT in the respo… - [Post searchv2alphalibraries search](https://api.aodocs.com/api-reference/search/post-searchv2alphalibraries-search.md): Searches documents in a view or a class matching the provided query. If the result set contains more than 10k documents, it's highly likely some results will be missing. You should always check if precision=INCOMPLETE_RESULT in the response. - [Templating](https://api.aodocs.com/api-reference/templating.md): Lets you execute file templating on a file - [Post templatingv1](https://api.aodocs.com/api-reference/templating/post-templatingv1.md): Execute file templating on the file. - [User](https://api.aodocs.com/api-reference/user.md): Lets you get information about users and groups (beta version, subject to change) - [Delete userv1 starred ](https://api.aodocs.com/api-reference/user/delete-userv1-starred-.md): Unstars a entity based on its type and ID for the given user. - [Get userv1](https://api.aodocs.com/api-reference/user/get-userv1.md): Gets user information for the given user. - [Get userv1 starred](https://api.aodocs.com/api-reference/user/get-userv1-starred.md): Lists starred entities based on its type for the given user. - [Get userv1beta1emailqualification](https://api.aodocs.com/api-reference/user/get-userv1beta1emailqualification.md): Gets information about an email address (Google user, member of the domain, allowlisted...). - [Get userv1beta1meroles](https://api.aodocs.com/api-reference/user/get-userv1beta1meroles.md): Lists domain role information for the current user of the given domain. - [Get userv1beta1meroles 1](https://api.aodocs.com/api-reference/user/get-userv1beta1meroles-1.md): Lists role information for the current user of the given library. - [Get userv1combinedsuggest](https://api.aodocs.com/api-reference/user/get-userv1combinedsuggest.md): Lists the users, groups and roles of the library matching a pattern. - [Get userv1group members](https://api.aodocs.com/api-reference/user/get-userv1group-members.md): Lists the users and groups which are members of the given Google group. - [Get userv1groupsuggest](https://api.aodocs.com/api-reference/user/get-userv1groupsuggest.md): Lists the groups either in library role, in a group or in a document's permissions matching a pattern. - [Get userv1licenseusersuggest](https://api.aodocs.com/api-reference/user/get-userv1licenseusersuggest.md): Lists the licensed users matching the query - [Get userv1me](https://api.aodocs.com/api-reference/user/get-userv1me.md): Gets user information for the current user. - [Get userv1storageaccounts](https://api.aodocs.com/api-reference/user/get-userv1storageaccounts.md): Lists storage accounts a user can use to create a library on a domain - [Get userv1userandgroupsuggest](https://api.aodocs.com/api-reference/user/get-userv1userandgroupsuggest.md): Lists the users and groups either in library role, in a group or in a document's permissions matching a pattern. - [Get userv1usersuggest](https://api.aodocs.com/api-reference/user/get-userv1usersuggest.md): Lists the users either in library role, in a group or in a document's permissions matching a pattern. - [Get userv1workflowtasks](https://api.aodocs.com/api-reference/user/get-userv1workflowtasks.md): Counts the number of documents that require a workflow transition by the given user, grouped by library, workflow, state (up to 1000 tasks). - [Patch userv1me](https://api.aodocs.com/api-reference/user/patch-userv1me.md): Updates user preferences partially (all non-specified field values will remain unchanged) - only works with editable properties. - [Post userv1 starred ](https://api.aodocs.com/api-reference/user/post-userv1-starred-.md): Stars a entity based on its type and ID for the given user. - [View](https://api.aodocs.com/api-reference/view.md): Lets you list existing views, update views, create new views - [Delete viewv1libraries views](https://api.aodocs.com/api-reference/view/delete-viewv1libraries-views.md): Deletes a view. - [Get viewv1libraries](https://api.aodocs.com/api-reference/view/get-viewv1libraries.md): Lists the ID/names of the views available in the library. - [Get viewv1libraries views](https://api.aodocs.com/api-reference/view/get-viewv1libraries-views.md): Gets a view. - [Patch viewv1](https://api.aodocs.com/api-reference/view/patch-viewv1.md): Updates a view (keep existing values for not specified fields). - [Post viewv1](https://api.aodocs.com/api-reference/view/post-viewv1.md): Updates a view configuration (reset not specified fields). - [Put viewv1](https://api.aodocs.com/api-reference/view/put-viewv1.md): Creates a new view in the library. - [Workflow](https://api.aodocs.com/api-reference/workflow.md): Lets you perform workflow actions and access workflow configuration (beta version, subject to change) - [Delete workflowv1beta1humanworkflowactions](https://api.aodocs.com/api-reference/workflow/delete-workflowv1beta1humanworkflowactions.md): Deletes a human workflow action. - [Delete workflowv2beta1workflows](https://api.aodocs.com/api-reference/workflow/delete-workflowv2beta1workflows.md): Deletes a workflow. - [Delete workflowv2beta1workflows states](https://api.aodocs.com/api-reference/workflow/delete-workflowv2beta1workflows-states.md): Deletes a workflow state. - [Delete workflowv2beta1workflows states transitions](https://api.aodocs.com/api-reference/workflow/delete-workflowv2beta1workflows-states-transitions.md): Deletes a workflow transition by workflow, state and transition ID. - [Delete workflowv2beta1workflowshumanworkflowactions](https://api.aodocs.com/api-reference/workflow/delete-workflowv2beta1workflowshumanworkflowactions.md): Deletes a human workflow action. - [Get workflowv1beta1humanworkflowactions](https://api.aodocs.com/api-reference/workflow/get-workflowv1beta1humanworkflowactions.md): Lists the human workflow actions available in the library. - [Get workflowv1beta1humanworkflowactions 1](https://api.aodocs.com/api-reference/workflow/get-workflowv1beta1humanworkflowactions-1.md): Gets a human workflow action by ID. - [Get workflowv1beta1libraries workbasketcount](https://api.aodocs.com/api-reference/workflow/get-workflowv1beta1libraries-workbasketcount.md): Counts the documents on which the user can trigger a workflow transition. - [Get workflowv1documents transitions](https://api.aodocs.com/api-reference/workflow/get-workflowv1documents-transitions.md): Lists the transitions available for a document. (Deprecated) Use document API v2 document.documents.listTransitions instead. - [Get workflowv1libraries](https://api.aodocs.com/api-reference/workflow/get-workflowv1libraries.md): Lists the workflows defined in the library. (Deprecated) Use workflow API v2 workflow.workflows.list instead. - [Get workflowv1libraries workbasket](https://api.aodocs.com/api-reference/workflow/get-workflowv1libraries-workbasket.md): Lists the documents on which the user can trigger a workflow transition. - [Get workflowv1libraries workflows](https://api.aodocs.com/api-reference/workflow/get-workflowv1libraries-workflows.md): Gets a workflow by ID. (Deprecated) Use workflow API v2 workflow.workflows.get instead. - [Get workflowv1libraries workflows states](https://api.aodocs.com/api-reference/workflow/get-workflowv1libraries-workflows-states.md): Lists the workflow states of a workflow in the library. (Deprecated) Use workflow API v2 workflow.workflows.get instead. - [Get workflowv1workflows transitions fields](https://api.aodocs.com/api-reference/workflow/get-workflowv1workflows-transitions-fields.md): Gets the Person fields of the document involved in any transitions of the workflow. - [Get workflowv2beta1workflows](https://api.aodocs.com/api-reference/workflow/get-workflowv2beta1workflows.md): Lists the workflows available for a library and potentially a document class. - [Get workflowv2beta1workflows 1](https://api.aodocs.com/api-reference/workflow/get-workflowv2beta1workflows-1.md): Gets a workflow by ID. - [Get workflowv2beta1workflows states](https://api.aodocs.com/api-reference/workflow/get-workflowv2beta1workflows-states.md): Lists the workflow states belonging to a workflow. - [Get workflowv2beta1workflows states 1](https://api.aodocs.com/api-reference/workflow/get-workflowv2beta1workflows-states-1.md): Gets a workflow state by workflow and state ID. - [Get workflowv2beta1workflows states transitions](https://api.aodocs.com/api-reference/workflow/get-workflowv2beta1workflows-states-transitions.md): Lists the workflow transitions of a workflow state by workflow and state ID. - [Get workflowv2beta1workflows states transitions 1](https://api.aodocs.com/api-reference/workflow/get-workflowv2beta1workflows-states-transitions-1.md): Gets a workflow transition by workflow, state and transition ID. - [Get workflowv2beta1workflowshumanworkflowactions](https://api.aodocs.com/api-reference/workflow/get-workflowv2beta1workflowshumanworkflowactions.md): Lists the human workflow actions available in the library. - [Get workflowv2beta1workflowshumanworkflowactions 1](https://api.aodocs.com/api-reference/workflow/get-workflowv2beta1workflowshumanworkflowactions-1.md): Gets a human workflow action by ID. - [Patch workflowv1beta1humanworkflowactions](https://api.aodocs.com/api-reference/workflow/patch-workflowv1beta1humanworkflowactions.md): Updates partially a human workflow action (all non-specified field values will remain unchanged). - [Patch workflowv2beta1workflows](https://api.aodocs.com/api-reference/workflow/patch-workflowv2beta1workflows.md): Updates partially a workflow configuration (all non-specified field values will remain unchanged). - [Patch workflowv2beta1workflows states](https://api.aodocs.com/api-reference/workflow/patch-workflowv2beta1workflows-states.md): Updates partially a workflow state configuration (all non-specified field values will remain unchanged). - [Patch workflowv2beta1workflows states transitions](https://api.aodocs.com/api-reference/workflow/patch-workflowv2beta1workflows-states-transitions.md): Updates partially a workflow transition (all non-specified field values will remain unchanged). - [Patch workflowv2beta1workflowshumanworkflowactions](https://api.aodocs.com/api-reference/workflow/patch-workflowv2beta1workflowshumanworkflowactions.md): Updates partially a human workflow action (all non-specified field values will remain unchanged). - [Post workflowv1beta1humanworkflowactions](https://api.aodocs.com/api-reference/workflow/post-workflowv1beta1humanworkflowactions.md): Creates a new human workflow action in the library. - [Post workflowv1documents states](https://api.aodocs.com/api-reference/workflow/post-workflowv1documents-states.md): Changes the workflow state of a document (as administrator). - [Post workflowv1documents states message](https://api.aodocs.com/api-reference/workflow/post-workflowv1documents-states-message.md): Changes the workflow state of a document (as administrator). - [Post workflowv1documents transitions](https://api.aodocs.com/api-reference/workflow/post-workflowv1documents-transitions.md): Executes a workflow transition for a document. - [Post workflowv1documents transitions message](https://api.aodocs.com/api-reference/workflow/post-workflowv1documents-transitions-message.md): Executes a workflow transition for a document. - [Post workflowv2beta1workflows](https://api.aodocs.com/api-reference/workflow/post-workflowv2beta1workflows.md): Creates a new workflow in the library for the given document class. - [Post workflowv2beta1workflows states](https://api.aodocs.com/api-reference/workflow/post-workflowv2beta1workflows-states.md): Creates a new workflow state for the given workflow. - [Post workflowv2beta1workflows states transitions](https://api.aodocs.com/api-reference/workflow/post-workflowv2beta1workflows-states-transitions.md): Create a new workflow transition for the workflow and workflow state. - [Post workflowv2beta1workflowshumanworkflowactions](https://api.aodocs.com/api-reference/workflow/post-workflowv2beta1workflowshumanworkflowactions.md): Creates a new human workflow action in the library. - [Authentication](https://api.aodocs.com/authentication.md): Every request sent to the AODocs **API** must include some method of authentication to verify the identity of a **Google user with access to AODocs**, and to authorize any activity done on their behalf. This is required regardless of whether the **API requestor** is a person manually interacting wit… - [Access APIs with Bearer tokens](https://api.aodocs.com/authentication/access-apis-with-bearer-tokens.md) - [Access APIs with security codes](https://api.aodocs.com/authentication/access-apis-with-security-codes.md): Security codes are the quickest way to authenticate with AODocs APIs. You create the security code in the AODocs Domain administration page, then you pass it along with each request as a **header parameter** to identify yourself. - [In-depth: OAuth implementation RFCs and BCPs](https://api.aodocs.com/authentication/auth-appendix.md) - [Authentication use case examples/options/flows](https://api.aodocs.com/authentication/sample-use-cases.md): To access AODocs APIs via OAuth 2.0, you need to provide an access token with each request. There are various flows to get an access token. - [Best practices](https://api.aodocs.com/best-practices.md) - [HTTP status codes and error handling](https://api.aodocs.com/best-practices/http-status-codes-and-error-handling.md): The HTTP status code that comes back along with the response indicates whether your request **succeeded**, **failed**, or **something else happened**. - [Performance considerations](https://api.aodocs.com/best-practices/performance-considerations.md): There are several ways that you can improve the performance of your interactions with AODocs APIs. - [Getting started](https://api.aodocs.com/getting-started.md) - [AODocs REST API documentation](https://api.aodocs.com/index.md): The AODocs REST API exposes most of the features of AODocs. It can be used to implement custom applications, third-party integration, bulk tools, or just to experiment with AODocs. - [Key concepts](https://api.aodocs.com/key-concepts.md): AODocs APIs let you *programmatically* access, manage, and configure AODocs objects and their associated metadata, including libraries, classes, documents, attachments, and properties. - [Basics of AODocs](https://api.aodocs.com/key-concepts/basics-of-aodocs.md) - [Basics of AODocs APIs](https://api.aodocs.com/key-concepts/basics-of-aodocs-apis.md): AODocs APIs are the HTTP endpoints which let you issue direct requests to the resource server to perform many of the manual tasks done in the AODocs UI: - [Manage AODocs documents](https://api.aodocs.com/manage-aodocs-documents.md): We put some of the most useful data-handling API methods together into a loose sequence you can follow in the [API portal](/api-reference/introduction). Or you can pick and choose the parts that help you accomplish your immediate goals with AODocs. - [Create, modify, delete documents](https://api.aodocs.com/manage-aodocs-documents/create-modify-delete-documents.md) - [Count documents of a library](https://api.aodocs.com/manage-aodocs-documents/create-modify-delete-documents/count-documents-of-a-library.md): You can count the number of documents associated with a particular library (and optionally class) as follows. - [Creating new AODocs documents](https://api.aodocs.com/manage-aodocs-documents/create-modify-delete-documents/create-new-documents-with-attachments.md): In AODocs, you can create new documents with either just a single attachment (TF/SF/DMS), or any number of attachments including zero (DMS-only). - [Create new document and attach Drive file](https://api.aodocs.com/manage-aodocs-documents/create-modify-delete-documents/create-new-documents-with-attachments/create-new-document.md) - [Create new document and attach Drive file](https://api.aodocs.com/manage-aodocs-documents/create-modify-delete-documents/create-new-documents-with-attachments/create-new-document-and-attach-drive-file.md): When you create a TF/SF document, you must attach one and only one attachment (using a Drive file’s fileId ). You create a DMS document the same way, but you can do it with any number of attachments (including zero). - [Before creating AODocs documents: Create test Drive folder and files](https://api.aodocs.com/manage-aodocs-documents/create-modify-delete-documents/create-new-documents-with-attachments/create-test-drive-files-and-folders.md): In order to have some test files and folders to work with, open up your [Google Drive](https://drive.google.com/) and create a Drive folder. Upload or create some files beside it as well as inside it. - [Delete a specific document by ID](https://api.aodocs.com/manage-aodocs-documents/create-modify-delete-documents/delete-document.md): You can delete a specific document if you have its documentId. You can either delete it permanently, or just send it to Trash. You can retrieve it from the Trash, or leave it there and it will get deleted after some designated amount of time. - [Get specific document by ID](https://api.aodocs.com/manage-aodocs-documents/create-modify-delete-documents/get-specific-document-by-id.md): You can retrieve (the configuration of) a specific document to parse something from its metadata (or just confirm it exists) if you have its `documentId`. - [List documents of a library](https://api.aodocs.com/manage-aodocs-documents/create-modify-delete-documents/list-documents-of-a-library.md): You can list documents associated with a particular library as follows. - [List and search documents](https://api.aodocs.com/manage-aodocs-documents/create-modify-delete-documents/list-search-and-count-documents.md) - [Modify document attachments](https://api.aodocs.com/manage-aodocs-documents/create-modify-delete-documents/modify-document-attachment.md) - [Modify document attachments](https://api.aodocs.com/manage-aodocs-documents/create-modify-delete-documents/modify-document-attachments.md): Using AODocs APIs, you can modify the document resource using the `PATCH` operation. You can modify attachments as well as [system and custom fields](/manage-aodocs-documents/create-modify-delete-documents/modify-field-values-of-document-properties/). To modify the list of document attachments (i.e.… - [Modify field values of document properties](https://api.aodocs.com/manage-aodocs-documents/create-modify-delete-documents/modify-field-values-of-document-properties.md): AODocs documents are composed of metadata, including (but not limited to) system and custom properties defined as part of a specific document type (also known as class). - [Search documents of a class](https://api.aodocs.com/manage-aodocs-documents/create-modify-delete-documents/search-documents-of-a-class.md): You can search for documents associated with a particular library and a particular class as follows. - [Get library and class info](https://api.aodocs.com/manage-aodocs-documents/get-library-and-class-info.md): Get all the IDs you need by getting or listing your resources as follows: - [Get a specific class by ID](https://api.aodocs.com/manage-aodocs-documents/get-library-and-class-info/get-a-specific-class-by-id.md): You can retrieve (the configuration of) a specific class/documentType to confirm it exists or to parse something from its metadata if you have its `documentTypeId` (class ID). - [Get a specific library by ID](https://api.aodocs.com/manage-aodocs-documents/get-library-and-class-info/get-a-specific-library-by-id.md): You can retrieve to parse something from its metadata (or to confirm it exists) if you have its `libraryId`. - [Get document class info](https://api.aodocs.com/manage-aodocs-documents/get-library-and-class-info/get-document-class-info.md): Libraries contain documents of various types. These document types, defined ahead of time, are called [classes](https://support.aodocs.com/hc/en-us/articles/205655634) . When a library is first created, it automatically gets outfitted with a default document type, or class. Other classes in your tar… - [Get library info](https://api.aodocs.com/manage-aodocs-documents/get-library-and-class-info/get-library-info.md): AODocs content is contained in libraries. Your libraries should already exist; if they don’t, a library administrator needs to [create them first](https://support.aodocs.com/hc/en-us/articles/115002366923-Create-a-library-from-scratch). - [List and search libraries (v2beta1)](https://api.aodocs.com/manage-aodocs-documents/get-library-and-class-info/list-and-search-libraries.md): This method allows you to search for target libraries on your domain with string queries (including quoted phrases) as well as several parameters to help narrow the scope. Without them, what comes back in the response is the full list of libraries available to you. - [List classes (to find target classes for your documents)](https://api.aodocs.com/manage-aodocs-documents/get-library-and-class-info/list-classes.md): You can list available target classes for your documents as follows: - [List libraries and find target library ID for your documents (legacy v1)](https://api.aodocs.com/manage-aodocs-documents/get-library-and-class-info/list-libraries-and-find-target-library-id-for-your-documents.md): To list target libraries on your domain, select a target library for your AODocs documents to be a part of, and note the target library’s unique identifier, `libraryId`. - [List libraries plain (alternative to List libraries)](https://api.aodocs.com/manage-aodocs-documents/get-library-and-class-info/list-libraries-plain.md): If you only need the library name and ID in the response, then you can use the plain library list ([ApiPlainLibraryList](/api-reference/library)) as an alternative to the full library list ([ApiLibraryList](/api-reference/library)). It is usually much faster than the standard library list API method… ## OpenAPI Specs - [workflow](https://api.aodocs.com/openapis/workflow.json) - [view](https://api.aodocs.com/openapis/view.json) - [user](https://api.aodocs.com/openapis/user.json) - [templating](https://api.aodocs.com/openapis/templating.json) - [search](https://api.aodocs.com/openapis/search.json) - [relation](https://api.aodocs.com/openapis/relation.json) - [referenceCatalog](https://api.aodocs.com/openapis/referenceCatalog.json) - [library](https://api.aodocs.com/openapis/library.json) - [job](https://api.aodocs.com/openapis/job.json) - [folder](https://api.aodocs.com/openapis/folder.json) - [driveImport](https://api.aodocs.com/openapis/driveImport.json) - [driveId](https://api.aodocs.com/openapis/driveId.json) - [domain](https://api.aodocs.com/openapis/domain.json) - [documentViewConfig](https://api.aodocs.com/openapis/documentViewConfig.json) - [documentType](https://api.aodocs.com/openapis/documentType.json) - [documentId](https://api.aodocs.com/openapis/documentId.json) - [document](https://api.aodocs.com/openapis/document.json) - [category](https://api.aodocs.com/openapis/category.json) - [attachment](https://api.aodocs.com/openapis/attachment.json) - [openapi](https://api.aodocs.com/api-reference/openapi.json) ## Optional - [About](https://www.aodocs.com/company/) - [Blog](https://www.aodocs.com/blog/) - [Status](https://status.aodocs.com/?__hstc=7523757.3689b6b59ff0c12fcac6aa9719dd6032.1586143551842.1586316583659.1586321455157.16&__hssc=7523757.35.1586321455157&__hsfp=209583371)