Get integrations

get https://sandbox.hurdlr.com/rest/v5/banks/integrations

Get all the integrations for the authenticated user

time	status	user agent
Retrieving recent requests…

Loading…

Response

Response body

object

data

array of objects

The list of entities

data

object

string

Id of the integration

status

string

required

Status of the integration

ACTIVE INACTIVE

apiAccessToken

string

required

Access token of the integration

apiName

string

required

Name of the integration's API

STRIPE PLAID GUSTO

businessId

string

Id of the business the integration is linked to

canAcceptPayments

boolean

Indicates if the integration can be used for accepting payments, e.g. with Stripe

merchantId

string

Id with various uses depending on the associated integration, listed below

STRIPE - A publicly accessible key used to identify your account with Stripe, for use within client-side code. See Stripe docs for Publishable Key

GUSTO - The UUID of the company associated with your Gusto account

PLAID - N/A, will always be null

apiUserId

string

User id with various uses depending on the associated integration

resetRequired

boolean

Indicates if there is an issue with the integration, requiring a reset from the user

createdDate

date-time

Date the integration was created

lastSyncedDate

date-time

Date the last time data was synced from the integration

lastInstitutionTranDate

date-time

Date of most recent transaction under the same institution as this integration, relevant for Plaid only

tokenStatus

string

Whether the access token has been invalidated or not

SUCCESS FAILURE_TOKEN_INVALIDATED

additionalConsentRequired

boolean

Flag to indicate additional user consent is required to access all features available on this integration. Commonly used to indicate there are more available products on a Plaid Item.

apiInstitutionName

string

Name of the institution of the integration

apiInstitutionId

string

Id of the institution of the integration

apiErrorCode

string

The specific error code. Intended for programmatic use

apiErrorDisplayMessage

string

A user-friendly description of the error code. Can change over time

apiErrorMessage

string

A developer-friendly description of the error. Can change over time

apiErrorType

string

A broad categorization of the error. Intended for programmatic use

glAccountId

string

General ledger account id, referencing an account in the chart of accounts

historicalReady

boolean

Indicates that historical transactions are available

initialReady

boolean

Indicates that initial transactions are available

lastUpdatedDate

date-time

Date filter - to be used in your subsequent request

cursor

string

Cursor to be used in your subsequent paginated request. Only populated if there are more pages available.

deletedIds

array of int32s

Ids of entities that no longer match the request's filter criteria since the request's lastUpdatedDate

deletedIds

Language

Credentials

OAuth2

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandbox.hurdlr.com/rest/v5/banks/integrations \
3
     --header 'accept: application/json'

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

application/json

200successful operation