Skip to main content
GET
/
public
/
v3
/
document-types
List document types
curl --request GET \
  --url https://api.quartr.com/public/v3/document-types \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.quartr.com/public/v3/document-types"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.quartr.com/public/v3/document-types', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
HttpResponse<String> response = Unirest.get("https://api.quartr.com/public/v3/document-types")
.header("x-api-key", "<api-key>")
.asString();
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.quartr.com/public/v3/document-types"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.quartr.com/public/v3/document-types",
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-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
{
  "data": [
    {
      "id": 7,
      "name": "Quarterly Report",
      "updatedAt": "2024-04-09T14:19:21.000Z",
      "createdAt": "2024-04-05T14:19:21.000Z",
      "category": "Report",
      "description": "General form for quarterly reports under Section 13 or 15(d)",
      "form": "10-Q",
      "documentGroupId": 1
    }
  ],
  "pagination": {
    "nextCursor": 10
  }
}
{
"error": "Bad Request",
"message": [
{
"field": "country",
"message": "country must be a valid ISO31661 Alpha2 code"
}
],
"statusCode": 400
}
{
"message": "Unauthorized",
"statusCode": 401
}
{
"message": "Forbidden",
"statusCode": 403
}

Authorizations

x-api-key
string
header
required

Query Parameters

limit
number
default:10

The maximum number of items to return in a single request.

Required range: 1 <= x <= 500
Example:

10

cursor
number
default:0

A unique identifier pointing to the starting position for the next set of results.

Required range: x >= 0
Example:

2432

direction
enum<string>
default:asc

The direction of the sort order (id field).

Available options:
asc,
desc
Example:

"asc"

Response

data
object[]
required
pagination
object
required