API Reference
  1. Surfact Platform API
  2. Events

All Events

get
https://api.surfact.com/api/v2.0/events/

Retrieve all events and automation rules configured in the organization, returned as a paginated list.

This endpoint supports the standard query conventions:

Example

curl -X GET 'https://api.surfact.com/api/v2.0/events/?isActive=true&sort_by=-lastTriggered' \
  -H 'X-Auth-Token: your_token_here'
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

Page number to retrieve. See Pagination.

integer

Items per page (default 50; 200 for variables). See Pagination.

string

Order results by an attribute; prefix - to reverse. See Sorting.

Case-insensitive search across the event name only. Unlike the devices and variables endpoints, generic search here does not cover label or description — use label__icontains or description__icontains for those. See Generic Search.

string

Comma-separated list of fields to include. See Dynamic Fields.

string

Comma-separated list of fields to omit. See Dynamic Fields.

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?