SCscanopy
Tag Groups

List tag groups

Changed on

Returns every tag group in your organization: the system groups (Application, Status) first, then the groups your organization named, by name.

get/api/v1/tag-groups

Request

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

Query parameters

systemboolean[] nullable

Only system groups (true), only the organization's own (false), or both (repeat it). Sent empty, matches none.

orderedboolean[] nullable

Only groups keeping their tags in a set order (true), by name (false), or both (repeat it). Sent empty, matches none.

entity_typesEntityDiscriminants[] nullable

Only groups that apply to one of these entity types. Repeat for several.

include_every_entity_typeboolean nullable

true also returns groups that apply to every entity type. Set on its own it returns only those.

tag_idsstring[] nullable

Only groups holding one of these tags. Repeat for several.

searchstring nullable

Free-text search. Case-insensitive substring match against the name and description.

group_by'created_at' | 'name' | 'updated_at' | 'group_type' | 'ordered'

Fields the tag groups 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' | 'group_type' | 'ordered'

Fields the tag groups list can be ordered and grouped by.

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

List of tag groups

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

{
  "data": [
    {
      "created_at": "2026-01-15T10:30:00Z",
      "description": "Which stage of delivery an asset serves.",
      "entity_types": null,
      "group_type": "Custom",
      "id": "550e8400-e29b-41d4-a716-446655440010",
      "name": "Environment",
      "ordered": true,
      "organization_id": "550e8400-e29b-41d4-a716-446655440001",
      "scope_computed": false,
      "updated_at": "2026-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "api_version": 1,
    "pagination": {
      "has_more": true,
      "limit": 50,
      "offset": 0,
      "total_count": 142
    },
    "server_version": "0.19.4"
  }
}

Changes

  • c9d9d46d1ae8Revision changes
    • info

      api operation id get_all_tag_groups removed and replaced with list_tag_groups

  • 9dda1a8b8ed1Revision changes
    • info

      the response required property ////// became read-only for the status