(v1) Synchronise Users

Returns a list of users the authenticated account has access to.

This is the preferred endpoint for fetching users. Cache the results on first call, then pass lastSynchronisationTimeOnServer from the previous response to retrieve only changed/new users on subsequent calls. This is significantly more performant than fetching the full list each time.

Supports cursor pagination (100 users per page).

Response notes:

  • mergedUsers: Array of merged user records since last call. oldId is the user ID that no longer exists — remove it from your cache.
  • idsOfDeletedUsers: IDs of deleted users since last call. Only returned for user IDs you provide in userIds. Remove these from your cache.
  • Coach (non-Admin) accounts: This endpoint will not return users who are still on the server but have been removed from a group you have access to. For these cases, use /api/v1/listgroups + /api/v1/groupmembers to get valid user IDs first.

Pagination:

Pass "paginate": "True" and an empty "cursor": "" on the first page. Use the cursor value from each response to fetch the next page (100 users per 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
number
required

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

userIds
array of integers

Optional list of user IDs to check for deletions or merges.

userIds
string
enum

Enable cursor pagination (100 users per page)

Allowed:
string

Cursor value from previous paginated response. Leave empty for 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