Skip to main content
GET
/
public-api
/
v1
/
events
/
{event_id}
Get Event
curl --request GET \
  --url https://app.cometly.com/public-api/v1/events/{event_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "profile_id": "<string>",
  "company_id": "<string>",
  "space_id": "<string>",
  "event_name": "<string>",
  "configured_name": "<string>",
  "amount": 123,
  "is_upsell": true,
  "event_time_utc": "<string>",
  "order_id": "<string>",
  "order_name": "<string>",
  "message": "<string>"
}

​
Overview

This endpoint allows you to retrieve the details of a previously created event from Cometly.

​
Path Parameters

​
event_id
string
required
The unique identifier of the event to retrieve

​
Response

​
Success Response

Returns the event object directly (not wrapped in a data property).
​
id
string
The unique identifier of the event
​
profile_id
string
The identifier of the contact profile associated with this event
​
company_id
string
Your company identifier
​
space_id
string
The space identifier this event belongs to
​
event_name
string
The name of the event (e.g., purchase, custom_event_1)
​
configured_name
string
The configured name of the event. For custom events (custom_event_1 through custom_event_50), this is the user-configured name. For standard events, this equals event_name.
​
amount
number
Transaction amount
​
is_upsell
boolean
Indicates if this is an upsell transaction
​
event_time_utc
string
Timestamp of when the event occurred (UTC)
​
order_id
string
Order identifier
​
order_name
string
Order name or description

​
Error Response

​
message
string
Error description explaining what went wrong

​
Example Requests

curl https://app.cometly.com/public-api/v1/events/evt_123456 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

​
Status Codes

Status CodeDescription
200Event successfully retrieved
401Missing or invalid API key
403API key doesn’t have permission or subscription is inactive
404Event not found
422Invalid event ID provided
429Too many requests - rate limit exceeded. See Rate Limiting

​
Notes

  • Rate Limit: This endpoint has a limit of 30 requests per minute per Space. See Rate Limiting for details.