ScanopyScanopy
Groups

List all groups

Returns all groups the authenticated user has access to. Supports pagination via limit and offset query parameters, and ordering via group_by, order_by, and order_direction.

GET
/api/v1/groups
Authorization<token>

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

In: header

Query Parameters

network_id?string|null

Filter by network ID

Formatuuid
group_by?null|GroupOrderField

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

order_by?null|GroupOrderField

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

order_direction?null|OrderDirection

Direction for order_by field (group_by always uses ASC).

limit?integer|null

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

Formatint32
Range0 <= value <= 1000
offset?integer|null

Number of results to skip. Default: 0.

Formatint32
Range0 <= value

Response Body

application/json

curl -X GET "https://loading/api/v1/groups"
{
  "data": [
    {
      "binding_ids": [],
      "color": "Blue",
      "created_at": "2026-01-15T10:30:00Z",
      "description": "HTTP/HTTPS services group",
      "edge_style": "Bezier",
      "group_type": "RequestPath",
      "id": "550e8400-e29b-41d4-a716-446655440008",
      "name": "Web Services",
      "network_id": "550e8400-e29b-41d4-a716-446655440002",
      "source": {
        "type": "Manual"
      },
      "tags": [],
      "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.13.5"
  },
  "success": true,
  "error": "string"
}