Project

Get project

Changed on

Return the requested project by its xid.

get/v1/projects/{projectId}

Request

  • Base URL: https://example.com/api
  • URL: https://example.com/api/v1/projects/{projectId}
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token; password, token URL /oauth/token, scopes: project.read)

Response

OK

idstring required

Unique identifier of the project.

keystring required

Key of the project.

namestring required

Name of the project.

descriptionstring nullable

Description of the project.

logostring uri nullable

Logo of the project.

status'active' | 'pending' required

Status of the project.

teamsstring[] required

IDs of the teams in the project.

document_countinteger nullable

Number of documents that belong to the project when projected.

issue_countinteger nullable

Number of issues that belong to the project when projected.

created_atstring date-time required

Date when the project was created.

updated_atstring date-time nullable required

Date when the project was updated.

Example response

{
  "id": "9bsv0s46s6s002p9ltq0",
  "key": "ENG",
  "name": "Engineering Project",
  "description": "Main engineering project",
  "logo": "https://example.com/logo.png",
  "status": "active",
  "teams": [
    "9bsv0s46s6s002p9ltq0"
  ],
  "document_count": 4,
  "issue_count": 12
}

Changes

  • 8a34c0b5508eRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status