cURL
curl --request POST \
--url https://aodocs.altirnao.com/api/search/v1/document \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"additionalFields": [
"<string>"
],
"filters": [
{
"column": "<string>",
"kind": "<string>",
"value": "<string>"
}
],
"kind": "<string>",
"sort": [
{
"ascending": true,
"fieldName": "<string>",
"kind": "<string>"
}
]
}
'import requests
url = "https://aodocs.altirnao.com/api/search/v1/document"
payload = {
"additionalFields": ["<string>"],
"filters": [
{
"column": "<string>",
"kind": "<string>",
"value": "<string>"
}
],
"kind": "<string>",
"sort": [
{
"ascending": True,
"fieldName": "<string>",
"kind": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
additionalFields: ['<string>'],
filters: [{column: '<string>', kind: '<string>', value: '<string>'}],
kind: '<string>',
sort: [{ascending: true, fieldName: '<string>', kind: '<string>'}]
})
};
fetch('https://aodocs.altirnao.com/api/search/v1/document', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://aodocs.altirnao.com/api/search/v1/document",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'additionalFields' => [
'<string>'
],
'filters' => [
[
'column' => '<string>',
'kind' => '<string>',
'value' => '<string>'
]
],
'kind' => '<string>',
'sort' => [
[
'ascending' => true,
'fieldName' => '<string>',
'kind' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://aodocs.altirnao.com/api/search/v1/document"
payload := strings.NewReader("{\n \"additionalFields\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"column\": \"<string>\",\n \"kind\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"kind\": \"<string>\",\n \"sort\": [\n {\n \"ascending\": true,\n \"fieldName\": \"<string>\",\n \"kind\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://aodocs.altirnao.com/api/search/v1/document")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"additionalFields\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"column\": \"<string>\",\n \"kind\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"kind\": \"<string>\",\n \"sort\": [\n {\n \"ascending\": true,\n \"fieldName\": \"<string>\",\n \"kind\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://aodocs.altirnao.com/api/search/v1/document")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"additionalFields\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"column\": \"<string>\",\n \"kind\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"kind\": \"<string>\",\n \"sort\": [\n {\n \"ascending\": true,\n \"fieldName\": \"<string>\",\n \"kind\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"count": 123,
"exactCount": true,
"hits": [
{
"additionalFields": [
{
"fieldName": "<string>",
"values": [
{}
]
}
],
"className": "<string>",
"documentId": "<string>",
"folderId": "<string>",
"folderIsRootFolderOfLibrary": true,
"folderName": "<string>",
"iconLink": "<string>",
"kind": "<string>",
"lastUpdateTimestamp": "2023-11-07T05:31:56Z",
"lastUpdater": {
"email": "<string>",
"personName": "<string>",
"thumbnailPictureLink": "<string>"
},
"libraryId": "<string>",
"libraryName": "<string>",
"stateName": "<string>",
"title": "<string>"
}
],
"kind": "<string>",
"nextPageToken": "<string>"
}search
Post searchv1document
Searches documents in the whole domain matching the provided query.
POST
/
search
/
v1
/
document
cURL
curl --request POST \
--url https://aodocs.altirnao.com/api/search/v1/document \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"additionalFields": [
"<string>"
],
"filters": [
{
"column": "<string>",
"kind": "<string>",
"value": "<string>"
}
],
"kind": "<string>",
"sort": [
{
"ascending": true,
"fieldName": "<string>",
"kind": "<string>"
}
]
}
'import requests
url = "https://aodocs.altirnao.com/api/search/v1/document"
payload = {
"additionalFields": ["<string>"],
"filters": [
{
"column": "<string>",
"kind": "<string>",
"value": "<string>"
}
],
"kind": "<string>",
"sort": [
{
"ascending": True,
"fieldName": "<string>",
"kind": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
additionalFields: ['<string>'],
filters: [{column: '<string>', kind: '<string>', value: '<string>'}],
kind: '<string>',
sort: [{ascending: true, fieldName: '<string>', kind: '<string>'}]
})
};
fetch('https://aodocs.altirnao.com/api/search/v1/document', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://aodocs.altirnao.com/api/search/v1/document",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'additionalFields' => [
'<string>'
],
'filters' => [
[
'column' => '<string>',
'kind' => '<string>',
'value' => '<string>'
]
],
'kind' => '<string>',
'sort' => [
[
'ascending' => true,
'fieldName' => '<string>',
'kind' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://aodocs.altirnao.com/api/search/v1/document"
payload := strings.NewReader("{\n \"additionalFields\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"column\": \"<string>\",\n \"kind\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"kind\": \"<string>\",\n \"sort\": [\n {\n \"ascending\": true,\n \"fieldName\": \"<string>\",\n \"kind\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://aodocs.altirnao.com/api/search/v1/document")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"additionalFields\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"column\": \"<string>\",\n \"kind\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"kind\": \"<string>\",\n \"sort\": [\n {\n \"ascending\": true,\n \"fieldName\": \"<string>\",\n \"kind\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://aodocs.altirnao.com/api/search/v1/document")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"additionalFields\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"column\": \"<string>\",\n \"kind\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"kind\": \"<string>\",\n \"sort\": [\n {\n \"ascending\": true,\n \"fieldName\": \"<string>\",\n \"kind\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"count": 123,
"exactCount": true,
"hits": [
{
"additionalFields": [
{
"fieldName": "<string>",
"values": [
{}
]
}
],
"className": "<string>",
"documentId": "<string>",
"folderId": "<string>",
"folderIsRootFolderOfLibrary": true,
"folderName": "<string>",
"iconLink": "<string>",
"kind": "<string>",
"lastUpdateTimestamp": "2023-11-07T05:31:56Z",
"lastUpdater": {
"email": "<string>",
"personName": "<string>",
"thumbnailPictureLink": "<string>"
},
"libraryId": "<string>",
"libraryName": "<string>",
"stateName": "<string>",
"title": "<string>"
}
],
"kind": "<string>",
"nextPageToken": "<string>"
}Authorizations
google_id_token-a99f12e0google_id_token_legacy-a99f12e0
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
The G Suite domain
The text searched to filter documents
The scope of the search: 'PROPERTIES_ONLY' to search only in the document metadata, 'ATTACHMENTS_ONLY' to search only in the attachment contents.
Available options:
PROPERTIES_ONLY, ATTACHMENTS_ONLY, PROPERTIES_AND_ATTACHMENTS 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.
The maximum number of documents per page. (Default: 20)
The timezone to use for datetime field searches (default: UTC). Format: 'Europe/Paris' or '+01:00'
The security code
Body
application/json
⌘I