Docs

Get Custom Licenses

gethttps://app.fossa.com/api/v2/dependencies/custom-licenses

Get custom licenses (dependency licenses that have been manually corrected) within the organization. This endpoint returns paginated results of custom licenses that have been created through project corrections. The results can be optionally filtered to a specific project using the `projectLocator` query parameter.

Query parameters

projectLocatorstring

Optional project locator to filter results to custom licenses used within a specific project. If not provided, returns custom licenses across all projects the user has access to.

pageinteger

The specific page of data to return

pageSizeinteger

The number of items to return in each page of results

Responses

200Successfully retrieved custom licenses
resultsobject[]required

Array of custom license objects

dependencyProjectLocatorstringrequired

The locator of the dependency project that this custom license applies to

dependencyRevisionLocatorstringrequired

The specific revision locator of the dependency

projectLocatorstringrequired

The locator of the user project that contains this dependency

projectRevisionstringrequired

The revision locator of the user project

titlestringrequired

The title/name of the dependency project

descriptionstringrequired

Description of the dependency project

urlstringrequired

URL for the dependency project

licenseTitlestringrequired

The custom license title/name

licenseIdenumrequired

The license identifier, always 'custom-license' for custom licenses

custom-license
copyrightstringrequired

Copyright notice for this license

textstringrequired

The full text of the license

correctedAtstring <date-time>required

Timestamp when the license correction was created

totalCountintegerrequired

Total number of custom licenses available (across all pages)

pageintegerrequired

Current page number

pageSizeintegerrequired

Number of items per page

400Bad Request
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

401Unauthorized
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

403Forbidden
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

404Project not found
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

500Server Error
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

Try this endpoint

Build a request and run it against app.fossa.com.

Bearer

Stored in this browser for 24 hours. Try It uses a docs proxy for CORS and does not store tokens server-side.

GET https://app.fossa.com/api/v2/dependencies/custom-licenses
curl --request GET \  --url 'https://app.fossa.com/api/v2/dependencies/custom-licenses' \  --header 'accept: application/json' \  --header 'authorization: Bearer YOUR_API_TOKEN'

Real request. Mutating methods can change data.

Click Try It to run a request and see the response here.
Enter a Bearer token before running this request.

Query params

projectLocatorstring

Optional project locator to filter results to custom licenses used within a specific project. If not provided, returns custom licenses across all projects the user has access to.

pageinteger

The specific page of data to return

pageSizeinteger

The number of items to return in each page of results

← All Dependencies endpoints