Get Businesses Enrollments

GET https://api.explorium.ai/v1/businesses/events/enrollments

Show businesses events enrollments records for user.

Endpoint: GET /v1/businesses/events/enrollments

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.

How It Works

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.

---

Example Request (cURL)

Bash

curl -X GET \
  "https://api.explorium.ai/v1/businesses/events/enrollments" \
  -H "API_KEY: your_api_key_here" \
  -H "parnter_id: your_partner_id" 

Example Response

Bash

{
  "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"]
    }
  ]
}