List people.
Returns the people the institution’s Users list shows, for the institution your API key is issued
for, in the standard list envelope (object: "list", has_more, next_cursor,
previous_cursor, data). Each person carries their roles, the departments an
administrator is limited to, whether the account is archived, and an administrator’s permissions.
Page forward by passing the returned next_cursor as starting_after. limit
defaults to 25 and is capped at 100. Results are ordered by id ascending.
Filter with ?role= (administrators, reviewers, students or
donors), ?q= (part of a name, the start of an email address or student number, or an
exact id) and ?status= (all, active or archived; archived accounts are
listed by default, as on the Users list).
Authentication
Query parameters
Which tab of the Users list (?role=): administrators, reviewers, students
or donors. The reviewers tab also lists anyone on a review group in the current award cycle.
Free-text search (?q=): matches part of a first or last name or organization, the start of
an email address or student number, or a person’s exact id.
Account status (?status=): all (the default, as the Users list shows), active
or archived.
Page size. Defaults to 25. Values outside 1–100 are clamped rather than rejected.
Opaque cursor. Pass the next_cursor from the previous page to page forward. Mutually exclusive with ending_before; if both are supplied, starting_after wins.
Opaque cursor. Pass the previous_cursor from the current page to page backward.
Optional extras to add to the response, comma-separated. total_count is the only supported value: it adds total_count, the number of records that match this request across all pages. The count is taken fresh at the moment of each request, so it can change while you page; ask for it on the first page. Without it, total_count is left out of the response. Asking or not never invalidates a cursor. Any other value returns 400 validation_failed.
Response
Discriminator constant. Always "list", mirroring Stripe’s list objects.
The request path this collection was served from (e.g. /api/v1/scholarships).
Opaque cursor for the next page (pass as starting_after). Null when there is none.
Opaque cursor for the previous page (pass as ending_before). Null when there is none.
The number of records that match the request across all pages, counted fresh on each
request. Present only when the request includes include=total_count; otherwise the
key is omitted.