Get a single project.

gethttps://app.fossa.com/api/projects/{locator}

Retrieve a single project by its locator, including its policy, update hook, labels, and saved issue filters, plus computed metadata: the head/latest/last-analyzed revisions, notifications, references, and contributor count. This endpoint implements its own access control via the project scope: a caller may read a project only if it is public or belongs to the caller's organization.

Path parameters

locatorstringrequired

The URL-encoded locator of the project (e.g., "git+github.com/owner/repo")

Query parameters

refstring

The branch or tag to use when computing the head/latest/last-analyzed revision metadata. Defaults to the project's default branch.

ref_typeenum

Whether `ref` refers to a branch or a tag. Defaults to `branch`.

branchtag

Responses

200The requested Project object. Contains the stored project fields plus the included `policy`, `updateHook`, `labels`, and `filters` relations and computed metadata fields (`head`, `latest`, `last_analyzed`, `notifications`, `references`, and `contributorCount`).

object

The Project object, including related records and computed metadata.

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

404Not Found - Project does not exist or you do not have access to it

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.

Language

Credentials

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/projects/git%252Bgithub.com%252Ffossas%252Ffossa-cli

curl --request GET \  --url 'https://app.fossa.com/api/projects/git%252Bgithub.com%252Ffossas%252Ffossa-cli' \  --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.

Path params

locatorstringrequired

The URL-encoded locator of the project (e.g., "git+github.com/owner/repo")

Query params

refstring

The branch or tag to use when computing the head/latest/last-analyzed revision metadata. Defaults to the project's default branch.

ref_typeenum

Whether `ref` refers to a branch or a tag. Defaults to `branch`.

← All Projects endpoints