ScanopyScanopy
Tag Groups

List tag groups

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

Authorization

Authorization<token>

User API key (Bearer scp_u_...). Create in Platform > API Keys.

In: header

Query Parameters

system?array<boolean>|

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

ordered?array<boolean>|

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

entity_types?array<>|

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

include_every_entity_type?|

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

tag_ids?array<>|

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

search?|

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

group_by?|

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

order_by?|

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

order_direction?|

Direction for order_by field (group_by always uses ASC).

limit?|

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

offset?|

Number of results to skip. Default: 0.

Response Body

application/json

curl -X GET "https://example.com/api/v1/tag-groups"
{
  "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.6"
  },
  "success": true,
  "error": "string"
}

Product names and logos are trademarks of their respective owners. See credits.