GET
/
public
/
v3
/
document-types
curl --request GET \
  --url https://api.quartr.com/public/v3/document-types \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": 7,
      "name": "Quarterly Report",
      "description": "General form for quarterly reports under Section 13 or 15(d)",
      "form": "10-Q",
      "updatedAt": "2024-04-09T14:19:21.000Z",
      "createdAt": "2024-04-05T14:19:21.000Z",
      "category": "Report",
      "documentGroupId": 1
    }
  ],
  "pagination": {
    "nextCursor": 10
  }
}

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: 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

200
application/json

The response is of type object.

GET
/
public
/
v3
/
document-types
curl --request GET \
  --url https://api.quartr.com/public/v3/document-types \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": 7,
      "name": "Quarterly Report",
      "description": "General form for quarterly reports under Section 13 or 15(d)",
      "form": "10-Q",
      "updatedAt": "2024-04-09T14:19:21.000Z",
      "createdAt": "2024-04-05T14:19:21.000Z",
      "category": "Report",
      "documentGroupId": 1
    }
  ],
  "pagination": {
    "nextCursor": 10
  }
}

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: 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

200
application/json

The response is of type object.