v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB
Data refresh

Trigger a Manual Data Refresh

Trigger on-demand data refresh for an entity that has an active consent

post/data/v2/refreshes

Query parameters

asyncboolean

When true the API will return a results_id which can be fetched from the /data/v2/results endpoint when ready. Note: it's recommended to use the sync flow (async=false) for all requests by adapting the data workflow for connected entities.

pageinteger

The page you're requesting - returns page 0 of a response if not specified.

sizeinteger

The number of objects you want to return as a page size.

entity_idstring uuid

The entity_id you're querying for, which is created by LinkSDK .connect() function.

metastring

Additional data you would like to store against the request. Example: {"foo": "val"}

Request body

entity_idstring uuid required

The entity_id you're querying for, which is created by LinkSDK .connect() function.

Response

OK

refresh_idstring uuid required

Refresh ID for the request created by server

statusstring required

Status of the data refresh which will be

messagestring required

Message

timestampstring date-time required

Data refresh trigger date time