Skip to navigation

List users

Lists the organisation’s users; status=DISCOVERED narrows to the admission queue a users:manage holder works through. A platform administrator also sees the members of organisations still pending approval.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

viewenumOptionalDefaults to latest

latest (the default) shows a row's pending proposal where one exists; approved shows what the platform enforces. Resources without proposals serve the same rows for both.

Allowed values:
statusenumOptional

Only users in this status; absent, every user. DISCOVERED is the admission queue. Any other value, or the parameter on another collection, refuses 400 MALFORMED_REQUEST.

Allowed values:

Response

Every row inside the principal's org, unordered; the projection position rides the body and the header.

globalSequencestringformat: "^[0-9]+$"

The position as a decimal string — the last change this member had applied, orders and balance readings included.

itemslist of objects
unscaledbooleanOptionalDeprecated

Never present since 0.3.3: every money value on this API states its own scale on the wire, so no item is ever served raw — the coarse collection form of RowExtras.unscaled, retired with it. Kept, deprecated, so a client generated from 0.3.2 still compiles.

Errors

400
List Users Request Bad Request Error
401
List Users Request Unauthorized Error
403
List Users Request Forbidden Error
503
List Users Request Service Unavailable Error