Skip to main content
GET
/
project
/
{projectId}
/
results
/
sca
/
licenses
/
summary
Get License Summary
curl --request GET \
  --url https://api.example.com/project/{projectId}/results/sca/licenses/summary
{
  "success": true,
  "data": {
    "projectId": "550e8400-e29b-41d4-a716-446655440001",
    "totalPackages": 142,
    "packagesWithLicenses": 135,
    "packagesWithoutLicenses": 7,
    "permissiveCount": 120,
    "weakCopyleftCount": 8,
    "strongCopyleftCount": 3,
    "unknownCount": 7,
    "ignoredCount": 4,
    "licenses": [
      {
        "spdxId": "MIT",
        "name": "MIT License",
        "category": "PERMISSIVE",
        "risk": "NONE",
        "riskDescription": "Minimal restrictions on use, modification, and redistribution",
        "count": 85
      },
      {
        "spdxId": "Apache-2.0",
        "name": "Apache License 2.0",
        "category": "PERMISSIVE",
        "risk": "NONE",
        "riskDescription": "Minimal restrictions on use, modification, and redistribution",
        "count": 25
      },
      {
        "spdxId": "GPL-3.0-only",
        "name": "GNU General Public License v3.0 only",
        "category": "STRONG_COPYLEFT",
        "risk": "HIGH",
        "riskDescription": "Requires derivative works to be released under the same license",
        "count": 3
      }
    ]
  }
}

Path Parameters

projectId
string
required
The UUID of the project

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": {
    "projectId": "550e8400-e29b-41d4-a716-446655440001",
    "totalPackages": 142,
    "packagesWithLicenses": 135,
    "packagesWithoutLicenses": 7,
    "permissiveCount": 120,
    "weakCopyleftCount": 8,
    "strongCopyleftCount": 3,
    "unknownCount": 7,
    "ignoredCount": 4,
    "licenses": [
      {
        "spdxId": "MIT",
        "name": "MIT License",
        "category": "PERMISSIVE",
        "risk": "NONE",
        "riskDescription": "Minimal restrictions on use, modification, and redistribution",
        "count": 85
      },
      {
        "spdxId": "Apache-2.0",
        "name": "Apache License 2.0",
        "category": "PERMISSIVE",
        "risk": "NONE",
        "riskDescription": "Minimal restrictions on use, modification, and redistribution",
        "count": 25
      },
      {
        "spdxId": "GPL-3.0-only",
        "name": "GNU General Public License v3.0 only",
        "category": "STRONG_COPYLEFT",
        "risk": "HIGH",
        "riskDescription": "Requires derivative works to be released under the same license",
        "count": 3
      }
    ]
  }
}