GET
/
documents
/
Get documents
curl --request GET \
  --url https://api.standardmetrics.io/v1/documents/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "id": "<string>",
      "name": "<string>",
      "link": "<string>",
      "company_id": "<string>",
      "information_request_id": "<string>",
      "parse_state": "<string>",
      "parsed_at": "2023-11-07T05:31:56Z",
      "uploaded_at": "2023-11-07T05:31:56Z",
      "source": "<string>",
      "submitted_date": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Your valid bearer token. All Auth tokens persist for all requests. Make sure to replace Client Credential Basic tokens with Bearer tokens after retrieving your bearer token. Go to the API Reference/Setup, User Guides/Initial Setup, or API Reference/Get API Access Token page to get your token.

Query Parameters

​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

​
company_id
string

The id for the company whose documents to request. You can get a company's id by making a request to the /companies endpoint.

​
parse_state
string

The parse state of the documents to request. One of "not-started", "in-progress", "completed", "needs-input", "not-parseable".

​
from
string<date-time>

The from date (inclusive) from which to query uploaded_at as an ISO 8601 formatted date

​
to
string<date-time>

The to date (inclusive) from which to query uploaded_at as an ISO 8601 formatted date

​
source
string

The source of the documents to request. One of "information-request", "implementation", "upload".

Response

200 - application/json

The response is of type object.