Skip to main content
SnapshotsVersion: v3

Get Snapshot Push between Dates

GET/snapshots/snapshot-status/{snapshotId}

Get list of sub-accounts snapshot pushed in time period

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Auth methods:OAuthPrivate Integration
Token type:Agency Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Path Parameters

snapshotIdstringrequired
Example:39It2BFz7EkNaNBALPif

Query Parameters

companyIdstringrequired
Example:5D112kQsiKESj6rash
fromstringrequired

Only accepts ISO 8601 format

Example:2022-10-10T12:00:00Z or 2022-10-10
tostringrequired

Only accepts ISO 8601 format

Example:2023-12-18T11:59:59Z or 2023-12-18
lastDocstringrequired

Id for last document till what you want to skip

Example:VUJO4Sw2TrDNZ5lx4wZg
limitstring

Limit of documents to return. Default is 20

Example:10

Response

Successful response

dataobject[]