Skip to navigation
APIsUser Resources

List all users

Returns a paginated list of users on your team.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Headers

X-Studies-Api-VersionstringOptional

Query parameters

perPageintegerOptional1-100Defaults to 10
The number of results to return per page, up to a maximum of 100.
pageintegerOptional>=1Defaults to 1
The page of results to return. The first page is 1.
namestringOptional

Filter resources to return by name, matching case-insensitively on any part of the name.

emailstringOptionalformat: "email"
Filter users to return by email address.
metadatastringOptional

Filter results by metadata value, matching against any metadata key. To filter on a specific key instead, pass the metadata slug itself as a query parameter, e.g. ?study-internal-id=STUDY-1234. Those slug parameters vary by team glossary and so cannot be enumerated here.

Response headers

X-RateLimit-LimitintegerOptional
The number of requests permitted in the current rate limit window.
X-RateLimit-RemainingintegerOptional

The number of requests still available in the current rate limit window. When several limits apply, this reflects the per-API-key limit, so a request can be rejected while this value is above zero.

X-RateLimit-ResetintegerOptional
The number of seconds until the current rate limit window resets.

Response

A page of users.
datalist of objects
The users on this page of results.
metaobject
Pagination counters describing the returned page of results.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error