Skip to main content
GET
/
api
/
v1
/
usage
/
events
Retrieves usage events
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
    }
  ]
}

Authorizations

x-api-key
string
header
required

Query Parameters

page
integer
default:1

Page number (starts from 1)

per_page
integer
default:25

Number of records per page

customer_key
string

Filter events by customer key

event_name
string

Filter events by event name

Response

Events fetched

statusCode
integer
Example:

200

message
string
Example:

"Events fetched"

meta
object
data
object[]