(v3) Get Users

get

https://{amsServer}/{amsAppName}/api/v3/users

Returns a list of users accessible to the authenticated account. REST equivalent of POST /api/v1/usersynchronise.

For most integrations, POST /api/v1/usersynchronise with caching and lastSynchronisationTimeOnServer is still the preferred pattern — it handles incremental sync more efficiently. Use this endpoint when a clean REST interface is preferred over the v1 sync pattern.

Access: Currently restricted to admin user type only. Pass userType=ADMIN as a required query parameter on every request — other values return 422.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

cursor

integer

Database ID as starting point for cursor-based pagination (returns records with ID greater than this value)

limit

integer

Maximum number of results to return

offset

integer

Number of records to skip before returning results

filter

string

Filter expression. Example: filter=in(id,1,2,3)

sortDir

string

enum

Sort direction

Allowed:

sortName

string

Field name to sort by

userType

string

enum

required

User type to return. Currently only ADMIN is supported — other values return 422. Additional user types will be enabled in a future release.

Allowed:

Headers

session-header

string

required

The current session token. Returned by most API calls and must be passed on all subsequent v2/v3 calls.

X-APP-ID

string

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

Response

200List of users accessible to the authenticated account