GET
/
v1
/
integrations
cURL
curl --request GET \
  --url https://api.comm.com/api/v1/integrations \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "meta": {
        "name": "<string>",
        "description": "<string>",
        "overview": "<string>",
        "solutions": [
          "SMS Marketing"
        ],
        "service": "Enrichment",
        "type": "<string>",
        "scopes": [
          {
            "method": "<string>",
            "endpoint": "<string>",
            "reason": "<string>"
          }
        ],
        "webhooks": {
          "live": "<string>",
          "sandbox": "<string>"
        },
        "events": {
          "subscribed": [
            {
              "type": "<string>",
              "reason": "<string>",
              "hold_until_response": true,
              "type_priority": 123,
              "is_optional": true
            }
          ],
          "errors": [
            {
              "type": "<string>",
              "description": "<string>"
            }
          ],
          "success_response": [
            {
              "type": "<string>",
              "description": "<string>"
            }
          ]
        },
        "custom_fields": [
          {
            "resource": "<string>",
            "name": "<string>",
            "type": "<string>",
            "description": "<string>"
          }
        ],
        "billing": {
          "managed_balance": true,
          "cost": [
            {
              "amount": 123,
              "currency": "<string>",
              "description": "<string>"
            }
          ],
          "overview": "<string>"
        },
        "required_fields": [
          {
            "type": "<string>",
            "name": "<string>",
            "description": "<string>",
            "default": "<string>",
            "required": true
          }
        ],
        "validate_api_key": true,
        "tags": [
          "<string>"
        ]
      },
      "type": "<string>",
      "team_id": "<string>",
      "status": "<string>",
      "vendor": {
        "id": "<string>",
        "name": "<string>",
        "status": "<string>",
        "meta": {
          "email": "<string>",
          "website": "<string>",
          "logo": "<string>"
        }
      },
      "team": {
        "id": "<string>",
        "integration_id": "<string>",
        "meta": {
          "events": [
            {
              "type": "<string>",
              "is_active": true
            }
          ],
          "required_fields": [
            {
              "name": "<string>",
              "value": "<string>"
            }
          ]
        }
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200
application/json

The collection of IntegrationData

The response is of type object.