Skip to main content
GET
Snapshot for the changes feed

Authorizations

X-API-Key
string
header
required

Query Parameters

type
enum<string>
required

document or company

Available options:
document,
company
Example:

"document"

pageToken
string | null

nextPageToken from the previous page; omit for the first page

limit
integer
default:100

Maximum number of items to return

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

100

companyIds
string | null

Comma-separated company IDs: only these companies, or only their documents

Example:

"77848abe-a215-41b7-8950-86e89ea1fadc"

Response

A page of documents

A page of the snapshot.

items
(ChangedDocument · object | CompanyResponse · object)[]
required

Documents or companies, as the changes feed shows them

A document as the API shows it, without file links (they expire; fetch them from GET /api/v2/documents/{id}).

nextPageToken
string | null
required

Pass as pageToken for the next page; null on the last page

cursor
integer
required

The feed position this snapshot started at, the same on every page: call GET /api/v2/changes with it as after once the snapshot is loaded