(v1) Filter Event Data

Returns events that match specific field-level data criteria, allowing server-side filtering on form field values.

Note: For most use cases, POST /api/v1/synchronise with local caching is still preferred — this endpoint is useful when you need to find events where a specific field equals a specific value.

Pagination:

Pass pagination parameters at the top level of the request body:

{
  "paginate": true,
  "cursor": "{{cursor}}"
}

Omit cursor on the first page. The response includes next_cursor — absent on the final page.

Upcoming enforcement: A future AMS release will add server-side enforcement that rejects unpaginated requests on high-volume endpoints. Implement pagination now to avoid disruption when that ships.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
required
Allowed:
string
enum
required
Allowed:
Body Params
filter
array of objects
required
filter*
integer
userIds
array of integers
userIds
string
string
string
string
boolean

Set to true to enable cursor pagination (100 events per page)

string | null

Cursor from previous paginated response. Omit or pass null on the first page.

Headers
string

A unique identifier for your application. Helps Teamworks support staff identify your requests if you need assistance.

Response

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json