Employee Data
...
Endpoints
Webhook Subscriptions

Subscription Management

9min
endpoints and functionality the subscription management endpoints allow you to see all available (webhook) subscriptions and related information see detailed information about your (webhook) subscriptions delete your subscriptions you will only be able to see the subscriptions connected to your token see the endpoints and their functions below endpoint function /v2/subscriptions see all your subscriptions, their status, creation, and expiration dates /v2/ subscriptions/{subsription id} see the details of your active subscriptions delete /v2/subscriptions/{subscription id} delete your subscriptions i want to see all my active subscriptions use the endpoint /v2/subscriptions 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 or expired = true ) you will automatically see only active subscriptions if you omit the expired = true/false parameter indicate which page number you wish to see each page contains 1,000 subscriptions, so if you have more than 1,000 subscriptions, you might need to indicate the page number replate {api key} with your api key in the template below request template curl x 'get' \\ 'https //api coresignal com/cdapi/v2/subscriptions?expired={false/true}\&page={integer}' \\ h 'accept application/json' \\ h 'apikey {api key}' request example curl x 'get' \\ 'https //api coresignal com/cdapi/v1/subscriptions?expired=false\&page=1' \\ h 'accept application/json' \\ h 'apikey {api key}' 4\ send the request 5\ 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" } ] data point description data type 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 request template curl x 'get' \\ 'https //api coresignal com/cdapi/v2/subscriptions/{subscription id}' \\ h 'accept application/json' \\ h 'apikey {api key}' 3\ send the request 4\ 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" } data point description data type 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 es 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 delete my subscription use the endpoint delete /v2/subscriptions/{id} to make your subscriptions inactive use your subscription id as input to request updates of employee profiles or experience changes refer to the template below template curl x 'delete' \\ 'https //api coresignal com/cdapi/v2/subscriptions/{subscription id}' \\ h 'accept / ' \\ h 'apikey {api key}'