organization-members

A viewset for listing, retrieving, and managing organization members.

Admin-only endpoint — lists both active and inactive members of the caller's organization, suitable for a datatable view. Non-admin members get 403.

Actions:

  • deactivate: POST to disable a member (prevent self-deactivation and protect the last active admin).
  • reactivate: POST to re-enable a member.
  • groups: POST to set a member's groups, and with them their capabilities (protects the last member who can manage members).
get/organization-members/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid

Query parameters

emailstring

Filter by partial email match

first_namestring

Filter by partial first name match

last_namestring

Filter by partial last name match

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

searchstring

Search by first name, last name, or email (OR)

Headers

X-Organization-Idstring

Selects the active organization for this request. Optional for callers that belong to exactly one active organization — the single membership is resolved implicitly. Required when the caller has two or more active memberships; omitting it in that case returns 400. If the header names an organization the caller is not an active member of, the server returns 403.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes

    • ▲

      removed the required property // from the response with the status

    • ○

      added the required property // to the response with the status

    • ▲

      removed the required property // from the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status