Subscription Management
The subscription management endpoints allow you to:
See all available (webhook) subscriptions and related information
See detailed information about your (webhook) subscriptions
Renew your subscriptions
Delete your subscriptions.
See the endpoints and their functions below:
/v2/subscriptions
See all your subscriptions, their status, creation, and expiration dates
/v2/subscriptions/{subsription_id}
See the details of your active subscriptions
/v2/subscriptions/{subscription_id}/renew
Renew your subscriptions for up to 1 year.
DELETE /v2/subscriptions/{subsription_id}
Delete your subscriptions
I want to see all my active subscriptions
Use the endpoint /v2/subscriptions/{subscription_id}
to see all your available subscriptions, their statuses, creation and expiration dates:
Indicate if you want to see the details of active or expired subscriptions (
expired = false
ORexpired = true
) You will automatically see only active subscriptions if you omit theexpired = true/false
parameter.Indicate which page number you would like to see. Each page contains approximately 1,000 subscriptions, so if you have more than 1,000 subscriptions, you may need to specify the page number.
Replace
{API Key}
with your API Key in the template below:
curl -X 'GET' \
'https://api.coresignal.com/cdapi/v2/subscriptions?expired={false/true}&page={integer}' \
-H 'accept: application/json' \
-H 'apikey: {API Key}'
Send the request.
Refer to the Body for information about your subscription status:
[
{
"id": "c8e295c0-2f85-473d-8bef-350526e6b30a",
"status": "active",
"created_at": "2024-09-18",
"expiring_at": "2024-12-18"
},
{
"id": "a85b2528-6190-4c91-8489-364b27ccbf81",
"status": "active",
"created_at": "2024-09-18",
"expiring_at": "2024-12-18"
}
]
id
Subscription identification key. Subscription ID is displayed in the response body after submitting a webhook subscription
String
status
Subscription status (active or expired)
String
created_at
Subscription start date in YYYY-MM-DD format
String (date)
expiring_at
Subscription expiry date in YYYY-MM-DD format
String (date)
I want to see the details of my subscriptions
Use the endpoint /v2/subscriptions/{id}
to see the details of your expired or active subscriptions:
Provide your
subscription_ID
*. 📌*Subscription ID is displayed in the response body after successfully submitting a webhook subscription.Replace
{API Key}
with your API Key in the template below:
curl -X 'GET' \
'https://api.coresignal.com/cdapi/v2/subscriptions/{subscription_id}' \
-H 'accept: application/json' \
-H 'apikey: {API Key}'
Send the request.
You will see the following information in the Response body:
{
"id": "c8e295c0-2f85-473d-8bef-350526e6b30a",
"status": "active",
"created_at": "2024-09-18",
"expiring_at": "2024-12-18",
"entity": "member_changes",
"es_dsl_query": null,
"filters": null,
"last_webhook_sent": "2024-09-30"
}
id
Subscription identification key.
String
status
Subscription status (active or expired)
String
created_at
Subscription start date in YYYY-MM-DD format
String (date)
expiring_at
Subscription expiry date in YYYY-MM-DD format
String (date)
entity
Subscription entity
String
es_dsl_query
Elasticsearch DSL query used to subscribe to changes in a list of profiles
Object
filters
Search filters used to subscribe to changes in a list of profiles
Object
last_webhook_sent
Time of the last message sent to your webhook URL in YYYY-MM-DD format
String (date)
I want to renew my subscription
Use the endpoint /v2/subscriptions/{subscription_id}/renew
to renew your subscriptions.
Provide your
subscription_ID
.Replace
{API Key}
with your API Key.
curl -X 'POST' \
'https://api.coresignal.com/cdapi/v2/subscriptions/{subscription_id}/renew' \
-H 'accept: application/json' \
-H 'apikey: {API Key}'
Send the request.
You will see the following information in the
Response
body:
{
"id": "4e11dcae-9bfb-4edb-b4f6-a0991b20fb50",
"status": "active",
"created_at": "2025-04-24T12:00:00.000000",
"expiring_at": "2025-10-24T12:00:00.000000",
}
id
Subscription identification key.
String
status
Subscription status (active or expired)
String
created_at
Subscription start date
String (date)
expiring_at
Subscription expiry date
String (date)
I want to delete my subscription
Use the endpoint DELETE /v2/subscriptions/{id}
to make your subscriptions inactive.
Use your subscription ID as input to request updates to employee profiles or experience changes. Refer to the template below:
curl -X 'DELETE' \
'https://api.coresignal.com/cdapi/v2/subscriptions/{subscription_id}' \
-H 'accept: */*' \
-H 'apikey: {API Key}'
Last updated
Was this helpful?