Skip to main content

List users

GET 
/users

Returns one page of the people in your tenant, in the order the directory hands them back.

The items are summaries, not users. Each entry carries four fields (id, username, email, enabled) and nothing else. This is not the same object GET /users/{username} returns: that operation answers with the directory's own representation of the user, a larger object with different field names. Fetch a user individually when you need anything beyond the four fields here.

The wrapper around the array carries eight keys: the array itself, the four pagination counters, count for the number of items actually in this page, and realm and customerId identifying the tenant the path resolved to. Other Prism list endpoints return a similar-looking wrapper with a different key set, so read the fields you need rather than assuming one shape across the API.

Watch the pageSize limit. The largest page this endpoint will serve is 1000, and an out-of-range value is not trimmed to the maximum; it resets to the default of 25. Asking for pageSize=5000 therefore returns 25 users, not 1000, with pageSize: 25 in the body and no warning anywhere. The same reset applies to pageSize=0, to negatives, and to anything that is not a number. Read pageSize back from the response whenever you did not send a value you are certain of.

One reporting caveat: if the count query behind total fails, Prism falls back to the number of rows on this page and still answers 200. A total that exactly equals count on a full page is worth a second look.

Request​

Responses​

One page of user summaries. A page past the end of the list, and a tenant with no users at all, are both a 200 with an empty users array.