v1

latestOpenAPI 3.0.02026-07-13103151174.7 KB

Projects

Get a Project

Get a Project by ID or key.

get/v1/projects/{key}

Path parameters

keystring required

A Project key or ID

Response

_idstring required

A unique Project ID

_organizationstring required

ID of the Organization owning the Project

_createdBystring required

ID of the User who created the project

namestring required

Project name

keystring required

A unique key to identify the Project

descriptionstring

A description of the Project

colorstring

Project display color, used to highlight different projects on the dashboard. Must use Hex color code.

createdAtstring date-time required

The date the Project was created

updatedAtstring date-time required

The date the Project was last updated

hasJiraIntegrationboolean required

Boolean tracking whether this project has a jira integration set up

hasReceivedCodeUsagesboolean required

Describe if a project has ever received code usages for any variable

hasUserConfigFetchboolean required

Boolean indicating whether a user config has been fetched for this project

jiraBaseUrlstring required

Jira project base url, if the integration is defined

readonlyboolean required

Controls whether the feature is editable for a given user

Example response

{
  "_id": "61450f3daec96f5cf4a49946",
  "name": "Delivery App",
  "key": "delivery-app",
  "description": "A web app to manage outbound deliveries",
  "color": "#4073FF"
}