Get details of a project

This call returns the details of a specified project.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Path for Seven Bridges Platform EU

If you are using Seven Bridges Platform EU, please use the following endpoint: https://eu-api.sbgenomics.com/v2/projects/{project_owner}/{project}

👍

Referring to your project

Note that project_owner is always case-sensitive, and that project is not the project's name but its short name. For full details of identifying objects using the API, please see the API overview.

See a list of Seven Bridges Platform-specific response codes that may be contained in the body of the response.

Interpreting the response body

  • The object type in the response should be ignored: all projects have type v2.
  • The dictionary settings contains one Boolean field, locked. This field shows whether or not your project is locked. You can lock down a project to prevent any Seven Bridges team member from viewing information about your project. Learn more about creating a locked project.
Path Params
string
required

If you are using Enterprise, use the name of the Division that owns the project; otherwise, enter the project owner's Platform username.

string
required

The short name of the project you are querying.

Query Params
fields
array of strings

Selector specifying a subset of fields to include in the response.

fields
Headers
string
required

Your Seven Bridges Platform authentication token. For security reasons, token will not be automatically populated in the generated code sample. Please replace <your-token-here> with your token before executing this call.

Response

Language
LoadingLoading…
Response
Choose an example:
application/json