SCscanopy
Users

List members

Changed on

The organization's users and its pending invites in one list, each limited to the ones the caller may see: every user and invite for an owner, otherwise the caller themselves, members below their role, and invites they created.

get/api/v1/users/members

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/users/members
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Query parameters

statusesMemberStatus[] nullable

Only members in one of these statuses. Repeat for several.

permissionsUserOrgPermissions[] nullable

Only members with one of these roles. Repeat for several.

site_idsstring[] nullable

Only users assigned one of these sites. Repeat for several.

all_sitesboolean nullable

true also returns admins and owners, who reach every site. Set on its own it returns only those.

auth_methodsstring[] nullable

Only users signing in one of these ways (<provider>, <provider>+password, password, none). Repeat for several.

invited_bystring[] nullable

Only invites created by one of these users. Repeat for several.

email_verifiedboolean[] nullable

Only users whose email is verified (true), unverified (false), or both (repeat it). Sent empty, matches none.

searchstring nullable

Free-text search. Case-insensitive substring match against the email.

group_by'created_at' | 'email' | 'invite_status' | 'permissions' | 'oidc_provider' | 'updated_at' | 'invited_by' | 'expires_at' | 'email_verified' | 'oidc_linked_at'

Fields the members list can be ordered and grouped by. Every one is derived in Rust.

Primary ordering field (used for grouping). Always sorts ASC to keep groups together.

order_by'created_at' | 'email' | 'invite_status' | 'permissions' | 'oidc_provider' | 'updated_at' | 'invited_by' | 'expires_at' | 'email_verified' | 'oidc_linked_at'

Fields the members list can be ordered and grouped by. Every one is derived in Rust.

Secondary ordering field (sorting within groups or standalone sort).

order_direction'asc' | 'desc'

Direction for ORDER BY clauses.

Direction for order_by field (group_by always uses ASC).

limitinteger nullable

Maximum number of results to return (1-1000, default: 50). Use 0 for no limit.

offsetinteger nullable

Number of results to skip. Default: 0.

Response

Users and pending invites

errorstring nullable

Human-readable failure message. Omitted on success.

successboolean required

true when the request succeeded. false responses carry error instead of data.

Example response

{
  "meta": {
    "api_version": 1,
    "pagination": {
      "has_more": true,
      "limit": 50,
      "offset": 0,
      "total_count": 142
    },
    "server_version": "0.19.4"
  }
}

Changes

  • c4e6ec11e35bRevision changes
    • info

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

  • 9dda1a8b8ed1Revision changes
    • breaking

      the ///////// response's property type changed from no type to string for status

    • breaking

      the ///////// response's property type changed from no type to string for status

    • breaking

      the ///////// response's property type changed from no type to string for status

    • breaking

      the ///////// response's property type changed from no type to string for status

    • breaking

      the ///////// response's property type changed from no type to string for status

    • warning

      added the new absolute enum value to the ///////// response property for the response status

    • warning

      added the new browser_default enum value to the ///////// response property for the response status

    • warning

      added the new browser_default enum value to the ///////// response property for the response status

    • warning

      added the new comfortable enum value to the ///////// response property for the response status

    • warning

      added the new compact enum value to the ///////// response property for the response status

    • warning

      added the new day_first enum value to the ///////// response property for the response status

    • warning

      added the new iso enum value to the ///////// response property for the response status

    • warning

      added the new monday enum value to the ///////// response property for the response status

    • warning

      added the new month_first enum value to the ///////// response property for the response status

    • warning

      added the new relative enum value to the ///////// response property for the response status

    • warning

      added the new sunday enum value to the ///////// response property for the response status

    • warning

      added the new twelve_hour enum value to the ///////// response property for the response status

    • warning

      added the new twenty_four_hour enum value to the ///////// response property for the response status

    • info

      removed from the ///////// response property oneOf list for the response status

    • info

      removed from the ///////// response property oneOf list for the response status

    • info

      removed from the ///////// response property oneOf list for the response status

    • info

      removed from the ///////// response property oneOf list for the response status

    • info

      removed from the ///////// response property oneOf list for the response status