# Get a project

From **GitHub v3 REST API**.

`GET /projects/{project_id}`

Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.

## Parameters

### `project_id`

- Location: path
- Required: true
- Type: `integer`

## Responses

### `200`

Response

### `application/json`

- Type: `object`

Projects are a way to organize columns and cards of work.

```json
{
  "body": "Developer documentation project for the developer site.",
  "columns_url": "https://api.github.com/projects/1002604/columns",
  "created_at": "2011-04-10T20:09:31Z",
  "creator": {
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "gravatar_id": "",
    "html_url": "https://github.com/octocat",
    "id": 1,
    "login": "octocat",
    "node_id": "MDQ6VXNlcjE=",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "site_admin": false,
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "type": "User",
    "url": "https://api.github.com/users/octocat"
  },
  "html_url": "https://github.com/api-playground/projects-test/projects/1",
  "id": 1002604,
  "name": "Projects Documentation",
  "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=",
  "number": 1,
  "owner_url": "https://api.github.com/repos/api-playground/projects-test",
  "state": "open",
  "updated_at": "2014-03-03T18:58:10Z",
  "url": "https://api.github.com/projects/1002604"
}
```

```json
{"description":"Projects are a way to organize columns and cards of work.","properties":{"body":{"description":"Body of the project","example":"This project represents the sprint of the first week in January","nullable":true,"type":"string"},"columns_url":{"example":"https://api.github.com/projects/1002604/columns","format":"uri","type":"string"},"created_at":{"example":"2011-04-10T20:09:31Z","format":"date-time","type":"string"},"creator":{"$ref":"#/components/schemas/nullable-simple-user"},"html_url":{"example":"https://github.com/api-playground/projects-test/projects/12","format":"uri","type":"string"},"id":{"example":1002604,"type":"integer"},"name":{"description":"Name of the project","example":"Week One Sprint","type":"string"},"node_id":{"example":"MDc6UHJvamVjdDEwMDI2MDQ=","type":"string"},"number":{"example":1,"type":"integer"},"organization_permission":{"description":"The baseline permission that all organization members have on this project. Only present if owner is an organization.","enum":["read","write","admin","none"],"type":"string"},"owner_url":{"example":"https://api.github.com/repos/api-playground/projects-test","format":"uri","type":"string"},"private":{"description":"Whether or not this project can be seen by everyone. Only present if owner is an organization.","type":"boolean"},"state":{"description":"State of the project; either 'open' or 'closed'","example":"open","type":"string"},"updated_at":{"example":"2014-03-03T18:58:10Z","format":"date-time","type":"string"},"url":{"example":"https://api.github.com/projects/1002604","format":"uri","type":"string"}},"required":["id","node_id","number","name","body","state","url","html_url","owner_url","creator","columns_url","created_at","updated_at"],"title":"Project","type":"object"}
```

### `304`

Not modified

### `401`

Requires authentication

### `application/json`

- Type: `object`

Basic Error

```json
{"description":"Basic Error","properties":{"documentation_url":{"type":"string"},"message":{"type":"string"},"status":{"type":"string"},"url":{"type":"string"}},"title":"Basic Error","type":"object"}
```

### `403`

Forbidden

### `application/json`

- Type: `object`

Basic Error

```json
{"description":"Basic Error","properties":{"documentation_url":{"type":"string"},"message":{"type":"string"},"status":{"type":"string"},"url":{"type":"string"}},"title":"Basic Error","type":"object"}
```

## Request examples

### cURL

```shell
curl --request GET \
  --url {protocol}://{hostname}/api/v3/projects/{project_id}
```