Skip to main content
GET
/
project
/
{projectId}
/
results
/
sca
/
licenses
/
{spdxId}
/
packages
Get Packages by License
curl --request GET \
  --url https://api.example.com/project/{projectId}/results/sca/licenses/{spdxId}/packages
{
  "success": true,
  "data": {
    "spdxId": "MIT",
    "name": "MIT License",
    "category": "PERMISSIVE",
    "risk": "NONE",
    "riskDescription": "Minimal restrictions on use, modification, and redistribution",
    "totalCount": 85,
    "packages": [
      {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "packageName": "lodash",
        "packageVersion": "4.17.21",
        "ecosystem": "npm",
        "licenses": ["MIT"],
        "isTransitive": false,
        "isDev": false,
        "isLicenseIgnored": false
      },
      {
        "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
        "packageName": "express",
        "packageVersion": "4.18.2",
        "ecosystem": "npm",
        "licenses": ["MIT"],
        "isTransitive": false,
        "isDev": false,
        "isLicenseIgnored": false
      }
    ]
  }
}

​
Path Parameters

​
projectId
string
required
The UUID of the project
​
spdxId
string
required
The SPDX license identifier (e.g., MIT, Apache-2.0, GPL-3.0-only). Use UNKNOWN to retrieve packages with no detected license.

​
Query Parameters

​
branch
string
Filter by Git branch name
​
organizationId
string
The UUID of the organization (required for permission resolution)
​
packageType
string[]
Filter by package ecosystem (e.g., npm, pip, maven, go). Can be specified multiple times.

​
Authorization

Requires read_scan_result permission on the project.

​
Response

​
success
boolean
Whether the request succeeded
​
data
object
{
  "success": true,
  "data": {
    "spdxId": "MIT",
    "name": "MIT License",
    "category": "PERMISSIVE",
    "risk": "NONE",
    "riskDescription": "Minimal restrictions on use, modification, and redistribution",
    "totalCount": 85,
    "packages": [
      {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "packageName": "lodash",
        "packageVersion": "4.17.21",
        "ecosystem": "npm",
        "licenses": ["MIT"],
        "isTransitive": false,
        "isDev": false,
        "isLicenseIgnored": false
      },
      {
        "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
        "packageName": "express",
        "packageVersion": "4.18.2",
        "ecosystem": "npm",
        "licenses": ["MIT"],
        "isTransitive": false,
        "isDev": false,
        "isLicenseIgnored": false
      }
    ]
  }
}