(v1) Search for a User

Search for a specific user by username, UUID, or email address.

Note: For fetching all users, /api/v1/usersynchronise is strongly preferred. Use this endpoint only when you need to look up a single specific user.

Omit all of username, uuid, and emailAddress to return all users (not recommended — use synchronise instead).

Pagination:

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

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

Omit cursor on the first page. Recommend 50–100 users per call — full-roster unpaginated calls cause performance issues.

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
identification
array of objects
required

An array containing one identification object — use one of username, uuid, or emailAddress

identification*
string
enum
Allowed:
string
Headers
string

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

Response
200

Matching user record(s)

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!