Skip to main content
POST
/
api
/
search
/
v1
/
libraries
/
{libraryId}
/
list
POST https://aodocs.altirnao.com/api/search/v1/libraries/Rs511XR8xAxGXu7nZYj/list

{
    "kind": "aodocs#documentList",
    "documentList": [
    {
        "kind": "aodocs#document",
        "libraryName": "my-DMS-lib-001",
        "className": "my-dms-class-002",
        "libraryId": "RnTG8PDu8ZqTuDVHcv",
        "classId": "RnTf1mx35gaTJLzoFp",
        "id": "RnTzVT28x5Sb48h3vSQ",  <ā€” documentId
        "title": "my-dms-doc-002",
        "richText": "",
        ...
    }
    ...
    {
        "kind": "aodocs#document",
        ...
    }
    ]
}

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.

Note:This is available only to library administrators.

ā€‹
Method and API

Play with the API Explorer:

POST /search/v1/libraries/\{libraryId\}/list

ā€‹
Usage/notes/guidelines

ā€‹
Request

libraryId is a path parameter. It is the only mandatory parameter. 
POST https://aodocs.altirnao.com/api/search/v1/libraries/Rs511XR8xAxGXu7nZYj/list

ā€‹
Responses

The response returns an ApiDocumentList resource, listing all documents associated with the specified library 
{
    "kind": "aodocs#documentList",
    "documentList": [
    {
        "kind": "aodocs#document",
        "libraryName": "my-DMS-lib-001",
        "className": "my-dms-class-002",
        "libraryId": "RnTG8PDu8ZqTuDVHcv",
        "classId": "RnTf1mx35gaTJLzoFp",
        "id": "RnTzVT28x5Sb48h3vSQ",  <ā€” documentId
        "title": "my-dms-doc-002",
        "richText": "",
        ...
    }
    ...
    {
        "kind": "aodocs#document",
        ...
    }
    ]
}