List documents
curl --request GET \
--url https://live.deck.co/api/v1/jobs/{jobGuid}/documents \
--header 'x-deck-client-id: <api-key>' \
--header 'x-deck-secret: <api-key>'import requests
url = "https://live.deck.co/api/v1/jobs/{jobGuid}/documents"
headers = {
"x-deck-client-id": "<api-key>",
"x-deck-secret": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-deck-client-id': '<api-key>', 'x-deck-secret': '<api-key>'}
};
fetch('https://live.deck.co/api/v1/jobs/{jobGuid}/documents', 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://live.deck.co/api/v1/jobs/{jobGuid}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-deck-client-id: <api-key>",
"x-deck-secret: <api-key>"
],
]);
$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://live.deck.co/api/v1/jobs/{jobGuid}/documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-deck-client-id", "<api-key>")
req.Header.Add("x-deck-secret", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://live.deck.co/api/v1/jobs/{jobGuid}/documents")
.header("x-deck-client-id", "<api-key>")
.header("x-deck-secret", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://live.deck.co/api/v1/jobs/{jobGuid}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-deck-client-id"] = '<api-key>'
request["x-deck-secret"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"documents": [
{
"document_id": "<string>",
"file_type": "<string>",
"metadata": {},
"file_name": "<string>",
"file_size": 123,
"fetch_date": "2023-11-07T05:31:56Z"
}
]
}{
"error_message": "<string>",
"display_message": "<string>"
}Storage
List documents
Returns a list of documents fetched during a job.
GET
/
jobs
/
{jobGuid}
/
documents
List documents
curl --request GET \
--url https://live.deck.co/api/v1/jobs/{jobGuid}/documents \
--header 'x-deck-client-id: <api-key>' \
--header 'x-deck-secret: <api-key>'import requests
url = "https://live.deck.co/api/v1/jobs/{jobGuid}/documents"
headers = {
"x-deck-client-id": "<api-key>",
"x-deck-secret": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-deck-client-id': '<api-key>', 'x-deck-secret': '<api-key>'}
};
fetch('https://live.deck.co/api/v1/jobs/{jobGuid}/documents', 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://live.deck.co/api/v1/jobs/{jobGuid}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-deck-client-id: <api-key>",
"x-deck-secret: <api-key>"
],
]);
$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://live.deck.co/api/v1/jobs/{jobGuid}/documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-deck-client-id", "<api-key>")
req.Header.Add("x-deck-secret", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://live.deck.co/api/v1/jobs/{jobGuid}/documents")
.header("x-deck-client-id", "<api-key>")
.header("x-deck-secret", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://live.deck.co/api/v1/jobs/{jobGuid}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-deck-client-id"] = '<api-key>'
request["x-deck-secret"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"documents": [
{
"document_id": "<string>",
"file_type": "<string>",
"metadata": {},
"file_name": "<string>",
"file_size": 123,
"fetch_date": "2023-11-07T05:31:56Z"
}
]
}{
"error_message": "<string>",
"display_message": "<string>"
}Authorizations
Enter your client id
Enter your secret
Path Parameters
The unique identifier of the job.
Query Parameters
When true (default), returns only documents with unique file content,
excluding duplicates. Set to false to return all documents.
Response
OK
Show child attributes
Show child attributes
Was this page helpful?
⌘I