GetIntegration | Edulead API

{
  "integration": {
    "id": "string",
    "connected": true,
    "account_id": "string",
    "instance_url": "string",
    "scopes": [
      "string"
    ],
    "connect_time": "2023-01-15T01:30:15.01Z",
    "app_installed": true,
    "contact_field_mappings": [
      {
        "edulead_field": "string",
        "crm_field": "string"
      }
    ],
    "institution_field_mappings": [
      {
        "edulead_field": "string",
        "crm_field": "string"
      }
    ],
    "field_mappings_configured": true,
    "missing_required_fields": [
      {
        "object_type": "INTEGRATION_OBJECT_TYPE_UNSPECIFIED",
        "edulead_field": "string",
        "label": "string"
      }
    ],
    "update_time": "2023-01-15T01:30:15.01Z"
  }
}

GetIntegration returns one integration, hubspot or salesforce; one the team has not connected is returned with connected false.

Authentication

AuthorizationBearer

A team API key, sent as Authorization: Bearer <key>.

AuthorizationBearer

The Cognito access token of a signed-in Edulead user (edulead auth login), sent as Authorization: Bearer <token>.

Path parameters

idenumRequired

Identifier of the resource, assigned by Edulead and opaque to callers.

Allowed values:

Response

Success

integrationobjectOptional

Integration is one CRM and the team’s connection to it; id is hubspot or salesforce. Only app_installed and the two mapping lists can change; the service sets the others.

Authentication

Path parameters

Headers

Response