List available CRM connectors with their auth descriptors

GET /crm/providers

List available CRM connectors with their auth descriptors

cURL

curl --request GET \
  --url https://api.pineyard.ai/crm/providers \
  --header 'Authorization: Bearer <token>'

200

{
  "providers": [
    {
      "slug": "<string>",
      "name": "<string>",
      "description": "<string>",
      "authMode": "API_KEY",
      "caps": {
        "lists": true,
        "webhooks": true,
        "pushOutcomes": true,
        "tasks": true,
        "dealStages": true
      },
      "apiKeyFields": [
        {
          "key": "<string>",
          "label": "<string>",
          "secret": true,
          "helpText": "<string>",
          "helpUrl": "<string>",
          "placeholder": "<string>"
        }
      ]
    }
  ]
}

Required scope: crm.view

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Response

200

application/json

OK

providers · object[] · required

Show child attributes