API Reference

Initiate Pull Session

post
https://endgrate.com/api/pull/initiate
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

A human-readable label for the session that will appear on the Sessions tab of your dashboard.

configuration_webhook
object

Endgrate will POST to this webhook when the session is configured by the user. This is useful if you want to get the integration provider chosen, any passthrough schemas, or passthrough fields without polling the GET api/session/configuration endpoint.

boolean
Defaults to false

Whether or not to allow the user to configure field mapping. See https://documentation.endgrate.com/docs/ux-customization#field-selection for more information.

boolean
Defaults to false

Whether or not passthrough fields are allowed. See https://documentation.endgrate.com/docs/passthrough-fields for more information.

boolean
Defaults to false

Whether or not passthrough schemas are allowed. See https://documentation.endgrate.com/docs/passthrough-schemas for more information.

boolean
Defaults to false

Whether or not to return only updated (new) data when pulling data. See https://documentation.endgrate.com/docs/sync for more information.

string

An integration provider. If specified, the user will not be shown the integration provider selection page and instead will be directed to the integration provider authentication page.

string

An integration provider list ID. If specified, the user will only be shown the integrations described in the integration provider list.

string

A URL that users will be redirected to after setting up the session. This is useful if you want to redirect your users back to your app.

boolean
Defaults to false

Whether or not to allow the user to choose the integrations for a given schema (e.g. choosing "Get Contacts" for a contact schema). See https://documentation.endgrate.com/docs/ux-customization#resource-selection for more information.

boolean
Defaults to false

Whether or not the session should be persisted permanently. If false, sessions will expire after 72 hours.

string
enum

An integration category. If specified, all common data model schemas from the category will be added for this session.

schema
array of objects

An array of schemas to be pulled in.

schema
boolean
Defaults to false

Whether or not to allow the user to choose which schemas to pull in. See https://documentation.endgrate.com/docs/ux-customization#resource-selection for more information.

boolean
Defaults to false

Whether or not to allow the user to see transfer statistics. See https://documentation.endgrate.com/docs/ux-customization#resource-selection for more information.

boolean
Defaults to false

Whether or not to execute POST requests to webhooks concurrently.

Responses

Callback

Updated about 1 year ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago