SCscanopy
User API Keys
internal

List user API keys

Changed on

The signed-in user's keys.

get/api/v1/user-api-keys

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/user-api-keys
  • Auth
    API key in cookie session_id

Query parameters

permissionsUserOrgPermissions[] nullable

Only keys limited to one of these roles. Repeat for several.

site_idsstring[] nullable

Only keys with access to one of these sites. Repeat for several.

is_enabledboolean[] nullable

Only enabled keys (true), disabled ones (false), or both (repeat it). Sent empty, matches none.

tag_idsstring[] nullable

Filter by tag IDs (returns keys that have ANY of the specified tags)

tag_setsstring[] nullable

Tag sets the key must hold one tag from each of. Each entry is a comma-separated list of tag ids. One entry per tag group the list is filtered by.

searchstring nullable

Free-text search. Case-insensitive substring match against the key's name.

group_by'created_at' | 'name' | 'updated_at' | 'permissions' | 'is_enabled' | 'last_used' | 'expires_at'

Fields the user API key list can be ordered and grouped by.

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

order_by'created_at' | 'name' | 'updated_at' | 'permissions' | 'is_enabled' | 'last_used' | 'expires_at'

Fields the user API key list can be ordered and grouped by.

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

group_by_tag_groupstring uuid nullable

Group by the tag each row holds from this tag group. Takes the place of group_by.

order_by_tag_groupstring uuid nullable

Sort by the position of the tag each row holds from this tag group. Takes the place of order_by.

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

List of user API keys

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