Retrieve connectors

NOTE: This end point requires authentication.

Query Params
string

Filter parameter can be used to filter connector list by connector property. This parameter should contain a comma-separated list of filter statements.
A filter statement is composed of the entity name (in this case, it is always 'connector'), the property name (e.g., 'stage'), the filter operator (e.g., 'eq'), and the quoted string value in parentheses (e.g., "('live')").
The following list of regular expressions describes acceptable filter statements:
• (connector).(id).(eq)(('[A-Z][A-Z][0-9]{5}'))
• (connector).(method).(eq)(('web'||'open-banking'|'pdf'|'csv'))
• (connector).(status).(eq|ne)(('operational'|'degraded-performance'|'partial-outage'|'major-outage'|'under-maintenance'))
• (connector).(status).(in)(([\w\W]+))
• (connector).(stage).(eq|ne)(('live'|'beta'|'alpha'))
• (connector).(stage).(in)(([\w\W]+))
• (connector).(scopes).(in|eq|ne)(([\w\W]+))
• (connector).(institution).(country).(eq|ne)(('Australia'|'New Zealand'))
• (connector).(institution).(country).(in)(([\w\W]+))
• (connector).(institution).(tier).(eq|ne)(('1'|'2'|'3'|'4'))
• (connector).(institution).(tier).(in)(([\W\d]+))
• (connector).(institution).(type).(eq|ne)(('Bank'|'Bank (Foreign)'|'Test Bank'|'Credit Union'|'Financial Services'|'Superannuation'))
• (connector).(authorization).(type).(eq|ne)(('user'|'user-mfa'|'user-mfa-intermittent'|'other'|'token'))
• (connector).(authorization).(type).(in)(([\w\W]+))
• (connector).(connectorEngine).(eq|ne)(('chrome'|'node'))
Multiple filter definitions should be separated with a comma (,).
For example, this filter statement will keep only live tier 1 and tier 2 institutions: filter=connector.stage.eq('live'),connector.institution.tier.in('1','2')

Responses

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