Trigger Pull

post

https://endgrate.com/api/pull/transfer

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

associations

object

An object specifying which endgrate_types to get associated resource data for.

endgrate_type

string

required

A valid endgrate_type for the session.

params

object

Optionally, filter by certain properties in your schema by specifying them here.

session_id

string

required

synchronous

boolean

Defaults to false

Whether or not to make this API request synchronous. If true, Endgrate will poll the status of the transfer internally, and return a response only when the transfer is completed, with a 5 minute maximum polling time.

completed_webhook

object

Endgrate will POST to this webhook whenever the transfer is completed.

data_webhook

object

Endgrate will POST to this webhook whenever new data is received. This is useful if you want to get transfer data without polling the GET api/pull/data endpoint.

error_webhook

object

Endgrate will POST to this webhook whenever an error occurs. This is useful if you want to get error information without polling the GET api/errors endpoint.

webhook_concurrency

boolean

Defaults to false

Whether or not to execute POST requests to webhooks concurrently.

Responses

Callbacks

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

defaultError