Documents

List all documents

Get a paginated list of all the documents associated with the specified order or query.

get/documents

Request

Base URL
https://api.datavant.io/v2
Auth
OAuth 2
Client credentials
Token URLhttps://api.datavant.io/v2/oauth2/token
TypeScript
https://skmtc.dev/datavant/apis/datavant-rest-api/docs/documents/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

order_idstring

order_uuidstring uuid4

query_idstring

query_uuidstring uuid4

chase_uuidstring uuid4

limitinteger

offsetinteger

Headers

version-datavantstring

Version of the Orders API to use with this call

Response

Successful Response

totalinteger required

limitinteger

offsetinteger

unfiltered_totalinteger

Example response

{
  "links": {
    "first": "/api/v1/users?limit=1&offset1",
    "last": "/api/v1/users?limit=1&offset1",
    "self": "/api/v1/users?limit=1&offset1",
    "next": "/api/v1/users?limit=1&offset1",
    "prev": "/api/v1/users?limit=1&offset1"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.