v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB

Pending & Asynchronous Requests

Get Results

Get the results for an asynchronous response. Note that the request willnot work for results_id that have been returned with a synchronousrequest, i.e.: it will work only when you receive a response for any APIwhere status=PENDING and then receive a webhook. **Note: it's recommended to use the sync flow (async=false) for all request by adapting the new data workflow. **

get/data/v2/results/{results_id}

Path parameters

results_idstring uuid required

results_id was returned from a request with async=true

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"}

Response

Get results

status'OK' | 'FAILED' | 'PENDING' | 'RECONNECT_REQUIRED' required

The status of the request.

dataobject required

The payload corresponding to the result requested, the schema of object depends on the original request was made to and it will be matching its response schema

results_idstring required

The ID for this result, this is used when retrieving results from the /results endpoint.

timestampstring required

The timestamp of when the response was retrieved

typestring required

The endpoint the original request was made to.