Skip to main content

Get provider

GET 

/providers/:provider_id

Get provider

Request

Path Parameters

    provider_id stringrequired

Responses

Provider

Schema
    id stringrequired
    application_id stringrequired
    category categoryrequired

    Possible values: [crm, engagement, enrichment, marketing_automation, no_category]

    auth_type stringrequired

    Possible values: [oauth2, api_key, access_key_secret]

    name provider_namerequired

    Possible values: [hubspot, salesforce, pipedrive, zendesk_sell, ms_dynamics_365_sales, zoho_crm, capsule, outreach, gong, apollo, salesloft, intercom, linear, clearbit, 6sense, marketo, salesforce_marketing_cloud_account_engagement, slack]

    config object

    An object that stores Oauth2/API key/access key related credentials.

    provider_app_id stringrequired
    use_managed_oauth boolean

    True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.

    oauth objectrequired
    oauth_scopes string[]required
    credentials objectrequired
    oauth_client_id stringrequired
    oauth_client_secret stringrequired
    objects object

    This is for field mappings when you data model using Objects. The field mappings (aka Schemas) here are set by you, the developer, and the mappings apply for all your customers.

    common object[]
  • Array [
  • name stringrequired
    schema_id string

    If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.

  • ]
  • standard object[]
  • Array [
  • name stringrequired
    schema_id string
  • ]
  • entity_mappings object[]deprecated

    This is for object/field mappings when you data model using Entities. The object/field mappings (aka Entity Mappings) here are set by you, the developer, and the mappings apply for all your customers.

  • Array [
  • entity_id stringrequired
    object object
    type stringrequired

    Possible values: [standard]

    name stringrequired
    field_mappings object[]
  • Array [
  • entity_field stringrequired

    The name of the field in your application.

    mapped_field stringrequired

    The name of the field in your customer's third-party Provider tool (e.g. Salesforce).

  • ]
  • ]
Loading...