Skip to main content
GET
/
v1
/
businesses
/
events
/
enrollments
Get Businesses Enrollments
curl --request GET \
  --url https://api.explorium.ai/v1/businesses/events/enrollments \
  --header 'api_key: <api-key>'
{
  "response_context": {
    "correlation_id": "<string>",
    "request_status": "success",
    "time_took_in_seconds": 123
  },
  "enrollments": [
    {
      "enrollment_id": "<string>",
      "enrollment_key": "<string>",
      "event_types": [
        "prospect_changed_role"
      ],
      "business_ids": [
        "<string>"
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developers.explorium.ai/llms.txt

Use this file to discover all available pages before exploring further.

Description

The Get Business Events Enrollments endpoint retrieves all your active event monitoring configurations. This allows you to review which businesses and event types you’re currently tracking, along with enrollment details.
  • Input: Either pass partner_id in the header; otherwise, your key will be used to infer you partner id.
  • Processing: The system retrieves all active enrollments associated with your partner_id.
  • Output: A structured response containing all enrollment configurations.
Bash
curl -X GET \
  "https://api.explorium.ai/v1/businesses/events/enrollments" \
  -H "API_KEY: your_api_key_here" \
  -H "partner_id: your_partner_id"
JSON
{
  "response_context": {
    "correlation_id": "1234",
    "request_status": "success",
    "time_took_in_seconds": 0.515
  },
  "enrollments": [
    {
      "enrollment_id": "en_7b429a01",
      "enrollment_key": "my_b2b_saas_monitor",
      "business_ids": ["8adce3ca1cef0c986b22310e369a0793", "665595bbb4e724de6f8bc705a5b84753"],
      "event_types": ["ipo_announcement", "new_funding_round", "new_product"]
    },
    {
      "enrollment_id": "en_9c31b8d2",
      "enrollment_key": "fintech_competitors",
      "business_ids": ["2222", "3333"],
      "event_types": ["new_partnership", "new_investment"]
    }
  ]
}

Authorizations

api_key
string
header
required

Response

Successful Response

This is base response model for all responses in partner service.

response_context
ResponseContext · object
required
enrollments
BusinessesEnrollment · object[]
required