Role Collections

Curated bundles of ONET roles that users group for reuse — for example a "Frontend Developers" or "SOC Analysts" collection. Endpoints under /api/v1/role-collections require a SAMS token and the **ONET** product entitlement.

List role collections

Return every role collection the caller owns plus any SHARED collections in their organization. Soft-deleted collections are excluded.

GET /api/v1/role-collections

Response

{
  "collections": [
    {
      "id": "5e9c2e30-7a44-4d2b-9c10-a1d8f4b6a2bf",
      "name": "Frontend Developers",
      "description": "Curated roles for frontend engineering",
      "color": "#FF5733",
      "visibility": "SHARED",
      "roleCount": 8,
      "createdAt": "2026-05-15T10:30:00Z",
      "createdByEmail": "ada@example.com"
    }
  ]
}

Export a role collection

Download the full collection — metadata plus every role in it — in JSON, CSV, or XML format.

GET /api/v1/role-collections/{id}/export

Parameters

Name
id
Type
string
Description
Role collection ID.
Name
format
Type
string
Description
Export format: json (default), csv, or xml.

Response

{
  "collection": {
    "id": "5e9c2e30-7a44-4d2b-9c10-a1d8f4b6a2bf",
    "name": "Frontend Developers",
    "description": "Curated roles for frontend engineering",
    "visibility": "SHARED",
    "createdAt": "2026-05-15T10:30:00Z"
  },
  "roles": [
    {
      "onetCode": "15-1254.00",
      "title": "Web Developers",
      "occupationFamily": "Computer Specialist",
      "jobZone": 3,
      "taskCount": 36,
      "technologySkillCount": 24,
      "stigMappingCount": 5,
      "addedAt": "2026-05-16T08:15:00Z"
    }
  ]
}

Returns 404 if the collection does not exist or the caller has no access (not the owner and not in an org that has it shared).