Get all connections
GET {{baseUrl}}/vault/connections?api={{unifiedApi}}&configured=true
This endpoint includes all the configured integrations and contains the required assets to build an integrations page where your users can install integrations. OAuth2 supported integrations will contain authorize and revoke links to handle the authentication flows.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
api | string | Scope results to Unified API | |
configured | boolean | Scopes results to connections that have been configured or not | |
cursor | null | ||
resource_id | null |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
x-apideck-consumer-id | string | (Required) ID of the consumer which you want to get or push data from | |
x-apideck-app-id | string | (Required) The ID of your Unify application | |
Accept | string |
RESPONSES
status: OK
{"status_code":200,"status":"OK","data":[{"id":"crm+salesforce","service_id":"salesforce","name":"Salesforce","tag_line":"CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.","unified_api":"crm","state":"authorized","integration_state":"configured","auth_type":"oauth2","oauth_grant_type":"authorization_code","status":"requested","enabled":true,"website":"https://www.salesforce.com","icon":"https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png","logo":"https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg","authorize_url":"https://unify.apideck.com/vault/authorize/salesforce/\u003capplication-id\u003e?state=\u003cstate\u003e","revoke_url":"https://unify.apideck.com/vault/revoke/salesforce/\u003capplication-id\u003e?state=\u003cstate\u003e","settings":{"instance_url":"https://eu28.salesforce.com","api_key":"12345xxxxxx"},"metadata":{"account":{"name":"My Company"},"plan":"enterprise"},"form_fields":[{"label":"Instance url","value":"https://eu28.salesforce.com","placeholder":"","mask":false,"type":"text","required":true,"disabled":false,"custom_field":false,"sensitive":false},{"label":"API Key","value":"123455677","placeholder":"","mask":false,"type":"text","required":true,"disabled":false,"custom_field":false,"sensitive":true}],"configuration":[{"resource":"leads","defaults":[{"target":"custom_fields","id":"ProductInterest","options":[{"label":"General Channel","value":"general"},{"label":"General Channel","value":"general"}],"value":"GC5000 series"},{"target":"custom_fields","id":"ProductInterest","options":[{"label":"General Channel","value":"general"},{"label":"General Channel","value":"general"}],"value":"GC5000 series"}]},{"resource":"leads","defaults":[{"target":"custom_fields","id":"ProductInterest","options":[{"label":"General Channel","value":"general"},{"label":"General Channel","value":"general"}],"value":"GC5000 series"},{"target":"custom_fields","id":"ProductInterest","options":[{"label":"General Channel","value":"general"},{"label":"General Channel","value":"general"}],"value":"GC5000 series"}]}],"configurable_resources":["opportunities","companies","contacts","leads"],"resource_schema_support":["leads"],"resource_settings_support":["leads"],"validation_support":false,"schema_support":true,"settings_required_for_authorization":["client_id","client_secret"],"subscriptions":[{"downstream_id":"5f5f5f5f5f5f5f5f5f5f5f5f","unify_event_types":["crm.contact.created","crm.contact.created"],"downstream_event_types":["contacts.CREATED","contacts.CREATED"],"execute_url":"https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}","created_at":"2020-10-01T12:00:00.000Z"},{"downstream_id":"5f5f5f5f5f5f5f5f5f5f5f5f","unify_event_types":["crm.contact.created","crm.contact.created"],"downstream_event_types":["contacts.CREATED","contacts.CREATED"],"execute_url":"https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}","created_at":"2020-10-01T12:00:00.000Z"}],"has_guide":true,"created_at":1615563533390,"custom_mappings":[{"type":"string","description":"Target Field Mapping example value from downstream","example":"Some value","readOnly":true,"nullable":true},{"type":"string","description":"Target Field Mapping example value from downstream","example":"Some value","readOnly":true,"nullable":true}],"updated_at":1616662325753},{"id":"crm+salesforce","service_id":"salesforce","name":"Salesforce","tag_line":"CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.","unified_api":"crm","state":"authorized","integration_state":"configured","auth_type":"oauth2","oauth_grant_type":"authorization_code","status":"live","enabled":true,"website":"https://www.salesforce.com","icon":"https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png","logo":"https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg","authorize_url":"https://unify.apideck.com/vault/authorize/salesforce/\u003capplication-id\u003e?state=\u003cstate\u003e","revoke_url":"https://unify.apideck.com/vault/revoke/salesforce/\u003capplication-id\u003e?state=\u003cstate\u003e","settings":{"instance_url":"https://eu28.salesforce.com","api_key":"12345xxxxxx"},"metadata":{"account":{"name":"My Company"},"plan":"enterprise"},"form_fields":[{"label":"Instance url","value":"https://eu28.salesforce.com","placeholder":"","mask":false,"type":"text","required":true,"disabled":false,"custom_field":false,"sensitive":false},{"label":"API Key","value":"123455677","placeholder":"","mask":false,"type":"text","required":true,"disabled":false,"custom_field":false,"sensitive":true}],"configuration":[{"resource":"leads","defaults":[{"target":"custom_fields","id":"ProductInterest","options":[{"label":"General Channel","value":"general"},{"label":"General Channel","value":"general"}],"value":"GC5000 series"},{"target":"custom_fields","id":"ProductInterest","options":[{"label":"General Channel","value":"general"},{"label":"General Channel","value":"general"}],"value":"GC5000 series"}]},{"resource":"leads","defaults":[{"target":"custom_fields","id":"ProductInterest","options":[{"label":"General Channel","value":"general"},{"label":"General Channel","value":"general"}],"value":"GC5000 series"},{"target":"custom_fields","id":"ProductInterest","options":[{"label":"General Channel","value":"general"},{"label":"General Channel","value":"general"}],"value":"GC5000 series"}]}],"configurable_resources":["opportunities","companies","contacts","leads"],"resource_schema_support":["leads"],"resource_settings_support":["leads"],"validation_support":false,"schema_support":true,"settings_required_for_authorization":["client_id","client_secret"],"subscriptions":[{"downstream_id":"5f5f5f5f5f5f5f5f5f5f5f5f","unify_event_types":["crm.contact.created","crm.contact.created"],"downstream_event_types":["contacts.CREATED","contacts.CREATED"],"execute_url":"https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}","created_at":"2020-10-01T12:00:00.000Z"},{"downstream_id":"5f5f5f5f5f5f5f5f5f5f5f5f","unify_event_types":["crm.contact.created","crm.contact.created"],"downstream_event_types":["contacts.CREATED","contacts.CREATED"],"execute_url":"https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}","created_at":"2020-10-01T12:00:00.000Z"}],"has_guide":true,"created_at":1615563533390,"custom_mappings":[{"type":"string","description":"Target Field Mapping example value from downstream","example":"Some value","readOnly":true,"nullable":true},{"type":"string","description":"Target Field Mapping example value from downstream","example":"Some value","readOnly":true,"nullable":true}],"updated_at":1616662325753}]}