List all events
Scope: crm:events.read https://api.alladdin.com/api/v2/events
Returns a paginated list of CRM events.
Results are cursor-paginated: the response includes a cursor value and a has_more boolean. Default page size is 50, configurable up to 100 with limit.
Parameters
Query parameters
cursor string optional
Pagination cursor from a previous response
limit integer optional = 50
Maximum number of items to return
Request
import requests
url = "https://api.alladdin.com/api/v2/events?cursor=value&limit=50"
headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Accept": "application/json",
}
response = requests.get(url, headers=headers)
print(response.json())Responses
Response
{
"items": [
{
"id": "507f1f77bcf86cd799439011",
"name": "string",
"contact_id": "string",
"contact_name": "string",
"kind": "string",
"description": "string",
"start_date": "2024-01-15T10:30:00Z",
"end_date": "2024-01-15T10:30:00Z",
"status": 0,
"tags": [
"string"
],
"location": "string",
"lead_id": "string",
"funnel_id": "string",
"user_id": "string",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
],
"cursor": "string",
"has_more": false
}Success responses
200 List of events application/json object items[] object[] required id string required
Unique identifier of the event
name string required
Event name
contact_id string | null required
Associated contact ID
contact_name string | null required
Contact display name
kind string | null required
Activity type key (e.g. call, meeting, task)
description string | null required
Event description
start_date string<date-time> | null required
Start date in ISO 8601 format
end_date string<date-time> | null required
End date in ISO 8601 format
status integer required
Event status (0 = pending, 1 = completed)
tags[] string[] required
List of tag names
location string | null required
Event location
lead_id string | null required
Associated deal/lead ID
funnel_id string | null required
Associated funnel ID
user_id string | null required
ID of the user assigned to the event
created_at string<date-time> | null required
Creation date in ISO 8601 format
updated_at string<date-time> | null required
Last update date in ISO 8601 format
cursor string | null optional has_more boolean required
Error responses
401 Invalid or missing API key application/json 403 Insufficient permissions application/json 429 Rate limit exceeded application/json