EventsList events
Events

List events

Retrieve events in the workspace.

curl -X GET "https://api.flameup.ai/api/v1/workspaces/example_string/events?limit=42&offset=42&user_id=example_string&event=example_string&since=2024-12-25T10:00:00Z&until=2024-12-25T10:00:00Z" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "events": [
    {
      "id": "example_string",
      "workspace_id": "example_string",
      "person_id": "123e4567-e89b-12d3-a456-426614174000",
      "event": "example_string",
      "properties": {},
      "timestamp": "2024-12-25T10:00:00Z",
      "created_at": "2024-12-25T10:00:00Z"
    }
  ],
  "total": 42
}
GET
/workspaces/{workspaceId}/events
GET
Security Scheme
Bearer Token
Bearer Tokenstring
Required

Your Flameup API key (passed as Bearer token)

Your Flameup API key (passed as Bearer token)
query
user_idstring

Filter by user ID

query
eventstring

Filter by event name

query
sincestring

Events after this time (ISO 8601)

Format: date-time
query
untilstring

Events before this time (ISO 8601)

Format: date-time
Request Preview
Response

Response will appear here after sending the request

Authentication

BearerAuth
header
Authorizationstring
Required

Bearer token. Your Flameup API key (passed as Bearer token)

Path Parameters

Query Parameters

user_idstring

Filter by user ID

eventstring

Filter by event name

sincestring

Events after this time (ISO 8601)

untilstring

Events before this time (ISO 8601)

Responses

eventsarray
totalinteger
Was this page helpful?
Built with Documentation.AI

Last updated today