(v1) Search Event Data

Searches for events matching date range and user criteria.

Note: For most use cases, POST /api/v1/synchronise with local caching and filtering is preferred. Use this endpoint when you specifically need server-side date filtering without maintaining a local cache.

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
formNames
array of strings
required

List of form names to return data for. Names must match exactly as they appear in AMS.

formNames*
string

Return events on or after this date. Format dd/mm/yyyy. Omit to return events with any start date.

string

Return events on or before this date. Format dd/mm/yyyy. Omit to return events with any finish date.

string

Filter by start time. Format h:mm AM/PM (e.g. 12:00 AM).

string

Filter by finish time. Format h:mm AM/PM (e.g. 11:59 PM).

integer

Maximum number of results to return per user

userIds
array of integers
userIds
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