v1

latestOpenAPI 3.0.0Apache 2.02026-07-13104382.5 KB
Connectors

Get Connector

Get Connector

get/connector/connectors/{id}

Path parameters

idstring required

ID of the record you are acting upon.

Headers

x-apideck-app-idstring required

The ID of your Unify application

Response

Connectors

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "data": {
    "id": "crm+salesforce",
    "name": "Salesforce",
    "description": "A description",
    "icon_url": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png",
    "logo_url": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg",
    "website_url": "https://www.salesforce.com",
    "signup_url": "https://www.salesforce.com/signup",
    "partner_signup_url": "https://www.salesforce.com/partners",
    "auth_type": "oauth2",
    "auth_only": true,
    "blind_mapped": true,
    "oauth_grant_type": "authorization_code",
    "oauth_credentials_source": "integration",
    "oauth_scopes": [
      {
        "id": "contacts:all",
        "label": "Read/write on the Contacts resource",
        "default_apis": [
          "crm"
        ]
      }
    ],
    "custom_scopes": true,
    "has_sandbox_credentials": true,
    "settings": [
      {
        "id": "pipeline_id",
        "label": "Pipeline",
        "type": "select"
      }
    ],
    "service_id": "close",
    "unified_apis": [
      {
        "id": "crm",
        "name": "File Storage API",
        "auth_only": true,
        "oauth_scopes": [
          {
            "id": "contacts:all",
            "label": "Read/write on the Contacts resource"
          }
        ],
        "supported_resources": [
          {
            "id": "companies",
            "name": "Companies",
            "downstream_id": "accounts",
            "downstream_name": "Accounts"
          }
        ],
        "downstream_unsupported_resources": [
          "companies"
        ],
        "supported_events": [
          {
            "event_type": "employee.created",
            "event_source": "native",
            "downstream_event_type": "person_created",
            "resources": [
              "companies"
            ],
            "entity_type": "employee"
          }
        ]
      }
    ],
    "supported_resources": [
      {
        "id": "companies",
        "name": "Companies",
        "downstream_id": "accounts",
        "downstream_name": "Accounts"
      }
    ],
    "configurable_resources": [
      "leads",
      "companies"
    ],
    "supported_events": [
      {
        "event_type": "employee.created",
        "event_source": "native",
        "downstream_event_type": "person_created",
        "resources": [
          "companies"
        ],
        "entity_type": "employee"
      }
    ],
    "webhook_support": {
      "mode": "native",
      "subscription_level": "integration",
      "managed_via": "api"
    },
    "schema_support": {
      "supported": true
    },
    "docs": [
      {
        "id": "12345",
        "name": "connection",
        "url": "https://unify.apideck.com/connector/connectors/workday/docs/consumer+connection"
      }
    ]
  },
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    },
    "total_count": 1,
    "warnings": [
      {
        "type": "downstream_request_failed",
        "status_code": 429,
        "operation": "getManager"
      }
    ]
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}