Search documents
curl --request GET \
--url https://api.hq.zone/v1/api/documents/search \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.hq.zone/v1/api/documents/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.hq.zone/v1/api/documents/search', 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://api.hq.zone/v1/api/documents/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hq.zone/v1/api/documents/search"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hq.zone/v1/api/documents/search")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hq.zone/v1/api/documents/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"categories": [
"<string>"
],
"documents": [
{
"auto_categorized": true,
"classification_status": "<string>",
"content_type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"download_url": "<string>",
"filename": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_owner": true,
"owner_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"profile_version": "<string>",
"reference_numbers": [
"<string>"
],
"scope": "<string>",
"sha256": "<string>",
"size_bytes": 123,
"tags": [
"<string>"
],
"updated_at": "2023-11-07T05:31:56Z",
"analysis_strategy": "<string>",
"caption": "<string>",
"category": "<string>",
"channel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel_name": "<string>",
"classification_confidence": 123,
"document_date": "2023-11-07T05:31:56Z",
"entities": "<unknown>",
"folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"language": "<string>",
"owner_display": "<string>",
"source_ref": "<string>",
"source_url": "<string>",
"summary": "<string>"
}
],
"tags": [
"<string>"
]
}Documents
Search documents
Performs a case-insensitive substring search over the filename, caption, summary, and tags of documents the caller can see, returning matches newest first. Visibility rules are the same as the list endpoint (private, channel, and team scopes). Accepts a required q query parameter and an optional limit (default 50, max 200); the categories and tags rollup fields are returned empty for this endpoint. Requires the documents:read scope.
GET
/
v1
/
api
/
documents
/
search
Search documents
curl --request GET \
--url https://api.hq.zone/v1/api/documents/search \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.hq.zone/v1/api/documents/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.hq.zone/v1/api/documents/search', 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://api.hq.zone/v1/api/documents/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hq.zone/v1/api/documents/search"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hq.zone/v1/api/documents/search")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hq.zone/v1/api/documents/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"categories": [
"<string>"
],
"documents": [
{
"auto_categorized": true,
"classification_status": "<string>",
"content_type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"download_url": "<string>",
"filename": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_owner": true,
"owner_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"profile_version": "<string>",
"reference_numbers": [
"<string>"
],
"scope": "<string>",
"sha256": "<string>",
"size_bytes": 123,
"tags": [
"<string>"
],
"updated_at": "2023-11-07T05:31:56Z",
"analysis_strategy": "<string>",
"caption": "<string>",
"category": "<string>",
"channel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel_name": "<string>",
"classification_confidence": 123,
"document_date": "2023-11-07T05:31:56Z",
"entities": "<unknown>",
"folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"language": "<string>",
"owner_display": "<string>",
"source_ref": "<string>",
"source_url": "<string>",
"summary": "<string>"
}
],
"tags": [
"<string>"
]
}Authorizations
bearer_patoauth2
Personal Access Token. Send as Authorization: Bearer hq_pat_....
⌘I