Events
Retrieve all events matching the query
GET /api/workspaces/{workspaceId}/events
Get a list of all events matching the query
Path parameters
-
occurrence_time_start
string date-time Required -
occurrence_time_end
string date-time Required -
labels
object -
sort_by
stringSort the resulting list by the following field (defaults to occurrence_time)
-
sort_direction
stringSort the resulting list in the following direction (defaults to ascending)
-
page
integerPage number which should be displayed; 0-indexed (defaults to 0)
-
limit
integerMaximum amount of results to display per page (defaults to 20)
Returns
200
OK
curl -X get \ https://studio.fiberplane.com/api/workspaces/%7BworkspaceId%7D/events \ -H 'Authorization: Bearer <YOUR_API_TOKEN>'
{ "type": "array", "items": { "type": "object", "required": [ "id", "title", "labels", "occurrenceTime", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "base64uuid" }, "title": { "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "occurrenceTime": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }}
Creates a new event
POST /api/workspaces/{workspaceId}/events
Creates a new event
Path parameters
-
workspaceId
string base64uuid RequiredThe workspace ID
Body parameters
Event creation payload
-
title
string Required -
labels
object -
time
string date-time
Returns
200
OK
curl -X post \ https://studio.fiberplane.com/api/workspaces/%7BworkspaceId%7D/events \ -H 'Authorization: Bearer <YOUR_API_TOKEN>'
{ "type": "object", "required": [ "id", "title", "labels", "occurrenceTime", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "base64uuid" }, "title": { "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "occurrenceTime": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }}
Delete a event
DELETE /api/events/{eventId}
Deletes a event
Path parameters
-
eventId
string base64uuid RequiredID of the event
Returns
200
OK
curl -X delete \ https://studio.fiberplane.com/api/events/%7BeventId%7D \ -H 'Authorization: Bearer <YOUR_API_TOKEN>'