(v1) Synchronise Event Data

Returns a list of events for a specified form.

This is the preferred read pattern. Cache results on first call, then use lastSynchronisationTimeOnServer from the previous response to fetch only changed/new events. Only fetch the full dataset on first sync.

Supports cursor pagination (100 events per page).

Pagination:

Pass pagination parameters as a nested object in the request body:

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

Omit cursor (or pass null) on the first page. Use the cursor value from each response to fetch the next 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.

lastSynchronisationTimeOnServer:

The lastSynchronisationTimeOnServer value returned in each response must be:

  1. Persisted after every call.
  2. Passed back as the lower time bound on the next call to retrieve only changed records.
  3. Never hardcoded to 0 or a fixed timestamp — doing so forces a full history scan on every run, which causes server-level memory exhaustion under concurrent load.

Error semantics:

  • HTTP 500 on this endpoint typically means the request payload is too large — usually caused by requesting too many users without pagination, or lastSynchronisationTimeOnServer: 0 on a large dataset. Enable pagination and pass a non-zero lastSynchronisationTimeOnServer on subsequent calls.
  • HTTP 403 means the authenticated account does not have access to the specified form. Check form permissions in the AMS Admin portal.
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
string
required

The exact name of the Event Form as configured in AMS

number
required

Server timestamp to limit results to events created or updated since this time. Set to 0 on first call to return all events. On subsequent calls, pass the value returned by the previous response.

userIds
array of integers

List of user IDs to return events for

userIds
pagination
object

Optional. Omit entirely to return all results unpaginated (not recommended for large datasets — see pagination warning above).

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