Skip to main content
GET
/
projects
/
{project_id}
get project
curl --request GET \
  --url https://api.example.com/projects/{project_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "slug": "<string>",
  "team_id": "<string>",
  "created_by_user_id": "<string>",
  "is_default": true,
  "n_codes": 123,
  "n_analyses": 123,
  "team": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "slug": "<string>",
    "is_default": true,
    "created_by_user_id": "<string>"
  },
  "created_by_user": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "username": "<string>"
  },
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "github_repo_id": 123,
  "github_repo": {
    "id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "is_private": true,
    "is_active": true,
    "installation": "<string>"
  }
}

Authorizations

Authorization
string
header
required

API key in Bearer token format

Path Parameters

project_id
string
required

Response

Successful Response

id
string
required
created_at
string<date-time>
required
name
string
required
slug
string
required
team_id
string
required
created_by_user_id
string
required
is_default
boolean
required
n_codes
integer
required
n_analyses
integer
required
team
TeamSchema · object
required
created_by_user
UserSchema · object
required
description
string | null
tags
string[]
github_repo_id
integer | null
github_repo
RepoSchema · object