Skip to main content
GET
/
v1
/
prospects
/
events
/
enrollments
Get Prospects Enrollments
curl --request GET \
  --url https://api.explorium.ai/v1/prospects/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"
      ],
      "prospect_ids": [
        "<string>"
      ]
    }
  ]
}

​
Description

The Get Prospect Events Enrollments endpoint retrieves all your active prospect monitoring configurations. This allows you to review which individuals and event types you’re currently tracking, along with enrollment details such as time-to-live settings..
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 account.
Output: A structured response containing all enrollment configurations.
Bash
curl -X GET \
  "https://api.explorium.ai/v1/prospects/events/enrollments" \
  -H "API_KEY: your_api_key_here" \
  -H "parnter_id: your_partner_id"
Bash
{
  "response_context": {
    "correlation_id": "1234",
    "request_status": "success",
    "time_took_in_seconds": 0.515
  },
  "enrollments": [
    {
      "enrollment_id": "en_8d52c3f1",
      "enrollment_key": "tech_executives_monitor",
      "prospect_ids": ["20ae6cbf564ee683e66685e429844a5ff8ffc30f", "4c485f009d59e319dc039cdf3e935b85014e6a33"],
      "event_types": ["prospect_changed_role", "prospect_changed_company"]
    },
    {
      "enrollment_id": "en_7d31a9c2",
      "enrollment_key": "sales_prospects",
      "prospect_ids": ["fd4c46716295a2e4731417eee802a883280e4d57", "a7bbe0674c63338e62ae4c10751ae19da5723e5a"],
      "event_types": ["prospect_job_start_anniversary", "prospect_changed_company"]
    }
  ]
}

Authorizations

​
api_key
string
header
required

Response

200 - application/json

Successful Response

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

​
response_context
object
required
​
enrollments
ProspectsEnrollment · object[]
required
⌘I