Get a project

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.

GET/projects/{project_id}

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Request

Path Parameters

project_id integer required

Responses

application/json Project object

Response

body string

requirednullable

Body of the project

Example: This project represents the sprint of the first week in January

columns_url string<uri>

required

Example: https://api.github.com/projects/1002604/columns

created_at string<date-time>

required

Example: 2011-04-10T20:09:31Z

creator Simple User object

requirednullable

Simple User

avatar_url string<uri>

required

Example: https://github.com/images/error/octocat_happy.gif

email string

optionalnullable

events_url string

required

Example: https://api.github.com/users/octocat/events{/privacy}

followers_url string<uri>

required

Example: https://api.github.com/users/octocat/followers

following_url string

required

Example: https://api.github.com/users/octocat/following{/other_user}

gists_url string

required

Example: https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id string

requirednullable

Example: 41d064eb2195891e12d0413f63227ea7

html_url string<uri>

required

Example: https://github.com/octocat

id integer

required

Example: 1

required

Example: octocat

name string

optionalnullable

node_id string

required

Example: MDQ6VXNlcjE=

organizations_url string<uri>

required

Example: https://api.github.com/users/octocat/orgs

received_events_url string<uri>

required

Example: https://api.github.com/users/octocat/received_events

repos_url string<uri>

required

Example: https://api.github.com/users/octocat/repos

site_admin boolean

required

starred_at string

optional

Example: "2020-07-09T00:17:55Z"

starred_url string

required

Example: https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url string<uri>

required

Example: https://api.github.com/users/octocat/subscriptions

type string

required

Example: User

url string<uri>

required

Example: https://api.github.com/users/octocat

html_url string<uri>

required

Example: https://github.com/api-playground/projects-test/projects/12

id integer

required

Example: 1002604

name string

required

Name of the project

Example: Week One Sprint

node_id string

required

Example: MDc6UHJvamVjdDEwMDI2MDQ=

number integer

required

Example: 1

organization_permission string

optional

The baseline permission that all organization members have on this project. Only present if owner is an organization.

Allowed: "read""write""admin""none"

owner_url string<uri>

required

Example: https://api.github.com/repos/api-playground/projects-test

private boolean

optional

Whether or not this project can be seen by everyone. Only present if owner is an organization.

state string

required

State of the project; either 'open' or 'closed'

Example: open

updated_at string<date-time>

required

Example: 2014-03-03T18:58:10Z

url string<uri>

required

Example: https://api.github.com/projects/1002604

Response Example: 200 application/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"
}

Not modified

application/json Basic Error object

Requires authentication

documentation_url string

optional

message string

optional

status string

optional

url string

optional

application/json Basic Error object

Forbidden

documentation_url string

optional

message string

optional

status string

optional

url string

optional

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

hostname

Self-hosted Enterprise Server or Enterprise Cloud hostname

protocol

Self-hosted Enterprise Server or Enterprise Cloud protocol

project_id *

Request Sample: Shell / cURL

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