curl --request GET \
--url https://{defaultHost}/api/v1/usage/events \
--header 'x-api-key: <api-key>'{
"statusCode": 200,
"message": "Events fetched",
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 4,
"limit_value": 25,
"next_page": null,
"prev_page": null,
"first_page": true,
"last_page": true,
"out_of_range": false
},
"data": [
{
"metadata": {},
"id": "1606b711-2f06-40f9-aa8c-276328360994",
"customer_id": "b2381521-1237-47f7-b5a2-26ef1ccbfe56",
"customer_name": null,
"customer_key": "cust-6d11ca90",
"event_name": "candidate.sourced",
"amount": 2,
"timestamp": "2025-08-21T14:57:21.000Z",
"credit_used": null,
"event_id": null
},
{
"metadata": {},
"id": "17600b11-6bc1-4619-b2c1-1f0214dd0939",
"customer_id": "b2381521-1237-47f7-b5a2-26ef1ccbfe56",
"customer_name": null,
"customer_key": "cust-6d11ca90",
"event_name": "interview.booked",
"amount": 4,
"timestamp": "2025-08-21T14:59:37.000Z",
"credit_used": null,
"event_id": null
}
]
}Fetches a paginated list of usage events. Pagination is automatically applied even if no page parameters are provided.
curl --request GET \
--url https://{defaultHost}/api/v1/usage/events \
--header 'x-api-key: <api-key>'{
"statusCode": 200,
"message": "Events fetched",
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 4,
"limit_value": 25,
"next_page": null,
"prev_page": null,
"first_page": true,
"last_page": true,
"out_of_range": false
},
"data": [
{
"metadata": {},
"id": "1606b711-2f06-40f9-aa8c-276328360994",
"customer_id": "b2381521-1237-47f7-b5a2-26ef1ccbfe56",
"customer_name": null,
"customer_key": "cust-6d11ca90",
"event_name": "candidate.sourced",
"amount": 2,
"timestamp": "2025-08-21T14:57:21.000Z",
"credit_used": null,
"event_id": null
},
{
"metadata": {},
"id": "17600b11-6bc1-4619-b2c1-1f0214dd0939",
"customer_id": "b2381521-1237-47f7-b5a2-26ef1ccbfe56",
"customer_name": null,
"customer_key": "cust-6d11ca90",
"event_name": "interview.booked",
"amount": 4,
"timestamp": "2025-08-21T14:59:37.000Z",
"credit_used": null,
"event_id": null
}
]
}Page number (starts from 1)
Number of records per page
Filter events by customer key
Filter events by event name
Events fetched
200
"Events fetched"
Show child attributes
Current page number
Total number of pages
Total number of events
Number of records per page
Next page number (null if on last page)
Previous page number (null if on first page)
Whether this is the first page
Whether this is the last page
Whether the requested page is out of range
Show child attributes
Additional metadata for the event
Unique event identifier
Internal customer ID
Customer name
Unique customer identifier in your application
Name of the event
Quantity/amount of usage
When the event occurred
Number of credits used for this event
External event identifier