Assets
Get a paginated list of assets with hierarchy.
Authorization
Authorization AuthorizationBearer <token>
In: header
Query Parameters
limit?number
Range
5 <= valueDefault
100page?number
Range
1 <= valueDefault
1organizationId*string
Length
1 <= lengthsortColumn?string
sortDirection?string
Value in
- "asc"
- "desc"
filterByName?string
filterByLabels?array<string>
filterByArchived?string
Default
"active"Value in
- "active"
- "archived"
parentId?string|null
maxDepth?number
Range
1 <= value <= 10Default
4Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/assets/?organizationId=string"{ "items": [ { "id": "string", "shortId": -9007199254740991, "slug": "string", "name": "string", "description": "string", "ownerId": "string", "createdAt": "string", "updatedAt": "string", "archivedAt": "string", "organizationId": "string", "status": "ACTIVE", "parentId": "string", "assetClassId": "string", "locationId": "string", "retentionPeriodId": "string", "lastReviewId": "string", "confidentialityRating": 0, "integrityRating": 0, "availabilityRating": 0, "owner": { "id": "string", "slug": "string", "name": "string", "description": "string", "archivedAt": "string", "organizationId": "string", "users": [ "string" ] }, "location": { "id": "string", "slug": "string", "name": "string", "description": "string", "createdAt": "string", "updatedAt": "string", "latitude": 0, "longitude": 0, "address": "string", "archivedAt": "string", "organizationId": "string" }, "retentionPeriod": { "id": "string", "slug": "string", "name": "string", "description": "string", "createdAt": "string", "updatedAt": "string", "archivedAt": "string", "organizationId": "string", "ruleSet": "string" }, "assetMemberships": [ { "assetId": "string", "businessRoleId": "string", "businessRole": { "id": "string", "slug": "string", "name": "string", "description": "string", "archivedAt": "string", "organizationId": "string", "users": [ "string" ] } } ], "assetClass": { "id": "string", "slug": "string", "name": "string", "description": "string", "createdAt": "string", "updatedAt": "string", "organizationId": "string", "archivedAt": "string", "confidentialityRating": 0, "integrityRating": 0, "availabilityRating": 0 }, "parent": { "id": "string", "shortId": -9007199254740991, "slug": "string", "name": "string", "description": "string", "ownerId": "string", "createdAt": "string", "updatedAt": "string", "archivedAt": "string", "organizationId": "string", "status": "ACTIVE", "parentId": "string", "assetClassId": "string", "locationId": "string", "retentionPeriodId": "string", "lastReviewId": "string", "confidentialityRating": 0, "integrityRating": 0, "availabilityRating": 0 }, "level": 0, "controlLinks": [ { "id": "string", "controlCoverageId": "string", "assetId": "string", "organizationId": "string", "linkedAt": "string", "linkedBy": "string", "controlCoverage": { "id": "string", "frameworkAdoptionId": "string", "controlId": "string", "coverageStatus": "FULL", "coverageGap": "string", "lastReviewedAt": "string", "reviewedBy": "string", "isNotRelevant": true, "notRelevantReason": "string", "notRelevantAt": "string", "notRelevantBy": "string", "policyId": "string", "sectionUid": "string", "organizationId": "string", "createdAt": "string", "updatedAt": "string", "control": { "id": "string", "frameworkId": "string", "parentId": "string", "identifier": "string", "slug": "string", "type": "CATEGORY", "isMandatory": true, "name": "string", "description": null, "purpose": "string", "isCentralized": true, "createdAt": "string", "updatedAt": "string" } } } ], "labels": [ { "assetId": "string", "labelId": "string", "organizationId": "string", "label": { "id": "string", "slug": "string", "name": "string", "scope": "string", "color": "string", "createdAt": "string", "updatedAt": "string", "archivedAt": "string", "organizationId": "string" } } ], "children": [ { "id": "string", "shortId": -9007199254740991, "slug": "string", "name": "string", "description": "string", "ownerId": "string", "createdAt": "string", "updatedAt": "string", "archivedAt": "string", "organizationId": "string", "status": "ACTIVE", "parentId": "string", "assetClassId": "string", "locationId": "string", "retentionPeriodId": "string", "lastReviewId": "string", "confidentialityRating": 0, "integrityRating": 0, "availabilityRating": 0, "owner": { "id": "string", "slug": "string", "name": "string", "description": "string", "archivedAt": "string", "organizationId": "string", "users": [ "string" ] }, "location": { "id": "string", "slug": "string", "name": "string", "description": "string", "createdAt": "string", "updatedAt": "string", "latitude": 0, "longitude": 0, "address": "string", "archivedAt": "string", "organizationId": "string" }, "retentionPeriod": { "id": "string", "slug": "string", "name": "string", "description": "string", "createdAt": "string", "updatedAt": "string", "archivedAt": "string", "organizationId": "string", "ruleSet": "string" }, "assetMemberships": [ { "assetId": "string", "businessRoleId": "string", "businessRole": { "id": "string", "slug": "string", "name": "string", "description": "string", "archivedAt": "string", "organizationId": "string", "users": [ "string" ] } } ], "assetClass": { "id": "string", "slug": "string", "name": "string", "description": "string", "createdAt": "string", "updatedAt": "string", "organizationId": "string", "archivedAt": "string", "confidentialityRating": 0, "integrityRating": 0, "availabilityRating": 0 }, "parent": { "id": "string", "shortId": -9007199254740991, "slug": "string", "name": "string", "description": "string", "ownerId": "string", "createdAt": "string", "updatedAt": "string", "archivedAt": "string", "organizationId": "string", "status": "ACTIVE", "parentId": "string", "assetClassId": "string", "locationId": "string", "retentionPeriodId": "string", "lastReviewId": "string", "confidentialityRating": 0, "integrityRating": 0, "availabilityRating": 0 }, "level": 0, "controlLinks": [ { "id": "string", "controlCoverageId": "string", "assetId": "string", "organizationId": "string", "linkedAt": "string", "linkedBy": "string", "controlCoverage": { "id": "string", "frameworkAdoptionId": "string", "controlId": "string", "coverageStatus": "FULL", "coverageGap": "string", "lastReviewedAt": "string", "reviewedBy": "string", "isNotRelevant": true, "notRelevantReason": "string", "notRelevantAt": "string", "notRelevantBy": "string", "policyId": "string", "sectionUid": "string", "organizationId": "string", "createdAt": "string", "updatedAt": "string", "control": { "id": "string", "frameworkId": "string", "parentId": "string", "identifier": "string", "slug": "string", "type": "CATEGORY", "isMandatory": true, "name": "string", "description": null, "purpose": "string", "isCentralized": true, "createdAt": "string", "updatedAt": "string" } } } ], "labels": [ { "assetId": "string", "labelId": "string", "organizationId": "string", "label": { "id": "string", "slug": "string", "name": "string", "scope": "string", "color": "string", "createdAt": "string", "updatedAt": "string", "archivedAt": "string", "organizationId": "string" } } ] } ] } ], "total": 0, "page": 0, "limit": 0}How is this guide?