Events
Get event
Retrieve a single event by its unique ID.
Authorization
x-kommunity-api-key
<token>In: header
Path Parameters
id
RequiredstringUnique identifier for the event
Response Body
Successfully retrieved event
success
booleandata
objectexport interface Response {
success?: boolean;
data?: {
event?: Event;
};
}
export interface Event {
/**
* Name of the event
*/
name?: string;
/**
* Detailed description of the event
*/
description?: string;
/**
* Primary category the event belongs to
*/
category?: string;
/**
* Subcategory for more specific event classification
*/
subcategory?: string;
/**
* Maximum number of attendees allowed (null means no limit)
*/
attendeeLimit?: number | null;
/**
* Country where the event takes place (required for in-person events)
*/
country?: string | null;
/**
* Street address (required for in-person events)
*/
street?: string | null;
/**
* City (required for in-person events)
*/
city?: string | null;
/**
* State or province (required for in-person events)
*/
state?: string | null;
/**
* Postal/ZIP code (required for in-person events)
*/
zipCode?: string | null;
/**
* URL to the event image
*/
eventImg?: string | null;
/**
* Event start time in ISO 8601 format (in UTC)
*/
startTime?: string;
/**
* Event end time in ISO 8601 format (in UTC)
*/
endTime?: string;
/**
* Timezone identifier for the event
*/
timezone?: string;
/**
* Contact email for the event
*/
email?: string;
/**
* Contact phone number
*/
phone?: string;
tickets?: {
id?: string;
name?: string;
price?: number;
}[];
joinUrl?: string | null;
questions?: {
id?: string;
question?: string;
required?: boolean;
}[];
}
curl -X GET "/api/v1/events/string" \
-H "x-kommunity-api-key: <token>"
{
"success": true,
"data": {
"event": {
"name": "string",
"description": "string",
"category": "string",
"subcategory": "string",
"attendeeLimit": 1,
"country": "string",
"street": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"eventImg": "string",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"timezone": "string",
"email": "[email protected]",
"phone": "string",
"tickets": [
{
"id": "string",
"name": "string",
"price": 0
}
],
"joinUrl": "string",
"questions": [
{
"id": "string",
"question": "string",
"required": true
}
]
}
}
}