Skip to main content
GET
/
library
/
v2beta1
/
search
cURL
curl --request GET \
  --url https://aodocs.altirnao.com/api/library/v2beta1/search \
  --header 'Authorization: Bearer <token>'
{
  "estimatedResultCount": true,
  "estimatedTaskCount": true,
  "facets": {
    "estimatedFacetCount": true,
    "labels": [
      {
        "count": 123,
        "value": {
          "createdAt": 123,
          "deleted": true,
          "id": "<string>",
          "kind": "<string>",
          "lastModifiedAt": 123,
          "leaf": true,
          "level": 123,
          "name": "<string>",
          "parent": "<string>",
          "parentIds": [
            "<string>"
          ],
          "rank": 123,
          "referenceCatalogId": "<string>"
        }
      }
    ],
    "libraryTypes": [
      {
        "count": 123,
        "value": "DMS"
      }
    ],
    "storageAccounts": [
      {
        "count": 123,
        "value": "<string>"
      }
    ]
  },
  "incompleteResults": true,
  "kind": "<string>",
  "libraries": [
    {
      "appMetadata": {},
      "currentUserRole": "NONE",
      "favorite": true,
      "folderVisibility": "PRIVATE",
      "hidden": true,
      "id": "<string>",
      "kind": "<string>",
      "labels": [
        {
          "createdAt": 123,
          "deleted": true,
          "id": "<string>",
          "kind": "<string>",
          "lastModifiedAt": 123,
          "leaf": true,
          "level": 123,
          "name": "<string>",
          "parent": "<string>",
          "parentIds": [
            "<string>"
          ],
          "rank": 123,
          "referenceCatalogId": "<string>"
        }
      ],
      "lastAccessed": 123,
      "libraryType": "DMS",
      "logoUrl": "<string>",
      "name": "<string>",
      "objectStorageLocation": "<string>",
      "onlyAdminsCanManageFolders": true,
      "redirectUrl": "<string>",
      "rootFolderId": "<string>",
      "statistics": {
        "attachmentsCount": 123,
        "classesCount": 123,
        "createdTime": "2023-11-07T05:31:56Z",
        "customScriptsCount": 123,
        "documentsCount": 123,
        "estimatedSubscriptionsCount": 123,
        "foldersCount": 123,
        "id": "<string>",
        "kind": "<string>",
        "lastModifiedTime": "2023-11-07T05:31:56Z",
        "librariesCount": 123,
        "librariesCountPerType": {},
        "licensedUsersCount": 123,
        "metadatasCount": 123,
        "publiclyShared": "<string>",
        "quotaUsageInDrive": 123,
        "quotaUsageInDrivePerStorageAccount": {},
        "relationsCount": 123,
        "usersCount": 123,
        "versionsCount": 123,
        "viewsCount": 123,
        "workflowStatesCount": 123,
        "workflowsCount": 123
      },
      "storageAccount": "<string>",
      "superAdminRole": "NONE",
      "taskCount": {
        "count": 123,
        "countByWorkflows": [
          {
            "classId": "<string>",
            "count": 123,
            "countByStates": [
              {
                "count": 123,
                "id": "<string>",
                "kind": "<string>",
                "name": "<string>"
              }
            ],
            "id": "<string>",
            "kind": "<string>",
            "name": "<string>"
          }
        ],
        "id": "<string>",
        "kind": "<string>",
        "libraryType": "DMS",
        "name": "<string>"
      }
    }
  ],
  "nextPageToken": "<string>",
  "totalResultCount": 123,
  "totalTaskCount": 123
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
query
string

Terms to search in the library name (will match word prefixes). You can search for exact phrases by quoting the whole parameter (example: "exact search" => will search for the whole words 'exact search' next to each other). You can also use the stemming operator to search for alternative forms of the search terms (example: ~"dog eat" => will also search for the dogs, eating in any order)

​
useSuperAdminAccess
boolean
default:false

(Super-admin only) Return libraries accessible with super admin role

​
minimumCurrentUserRole
enum<string>
default:READER

Return only libraries with at least this role for the current user. Only ADMIN, WRITER, READER are valid values

Available options:
NONE,
READER,
COMMENTER,
ATTACHMENT_EDITOR,
WRITER,
ADMIN,
SUPER_ADMIN
​
withHidden
boolean
default:false

Return libraries that would be hidden from the current user.

​
libTypes
enum<string>[]

Return libraries of these types

Available options:
DMS,
SF,
TF
​
storageAccount
string

Return only libraries of this storage account

​
labelIds
string[]

Return libraries with at least one of these labels

​
appMetadataTags
string[]

Return the libraries with all the provided app metadata tags. App metadata tags can be queried at three levels with the following syntax: 'appNamespaceId', 'appNamespaceId.tagName' or 'appNamespaceId.tagName:tagValue'. App metadata tags can be excluded by adding a '-' character before the tag name ('-appNamespaceId', '-appNamespaceId.tagName' or '-appNamespaceId.tagName:tagValue').

​
favorite
boolean
default:false

If true, returns only favorite libraries

​
orderBy
enum<string>

Sort by ascending NAME, by descending LAST_ACCESSED and TASK_COUNT or with FAVORITE_FIRST. If orderBy is provided, only up to results can be returned (check incompleteResults in response). If not set results will be in an arbitrary order, but will be faster and allow to list more than 10000

Available options:
NAME,
LAST_ACCESSED,
TASK_COUNT,
FAVORITE_FIRST
​
limit
integer<int32>
default:20

The maximum number of items to return(defaults to 20, max 1000)

​
requirePreciseResults
boolean
default:false

Set to true if you need an exact total result count (up to 25000) and need to check that the response contains all results (slower results). If false, will only return an estimate of the total number of results.

​
facets
boolean
default:false

Set to true to enable facet results on library types, storage accounts and labels (slower response)

​
include
enum<string>[]

Set additional information to return (each additional include slows the response). Available values: STATISTICS (super admin only), LABELS, IS_FAVORITE, LAST_ACCESSED, TASK_COUNT

Available options:
STATISTICS,
LABELS,
IS_FAVORITE,
LAST_ACCESSED,
TASK_COUNT
​
pageToken
string

The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.

​
domain
string

The G Suite domain

​
securityCode
string

The security code

Response

200 - application/json

A ApiLibrarySearchResultList response

A list of library search results

​
estimatedResultCount
boolean

If true, totalResultCount is an estimate, that might be wrong by a large factor but should be the right order of magnitude

​
estimatedTaskCount
boolean

If true, totalTaskCount is only an estimate of the real task count (only present if the query returns task counts)

​
facets
object

The facets associated with the current library search result

​
incompleteResults
boolean

Whether this request cannot return all results. If true, either use a more precise query, or remove the orderBy parameter

​
kind
string
​
libraries
object[]

List of libraries matching the search parameters

​
nextPageToken
string

If the search has more results, the value to be passed as 'pageToken' to get the next page

​
totalResultCount
integer<int32>

Total number of libraries for this search. Might be an estimate, check estimatedResultCount as well

​
totalTaskCount
integer<int32>

Total number of tasks for the user. Might be a lower bound, check estimatedResultCount as estimatedTaskCount (only present if the query returns task counts)