Get project for user | Sample

2 parameters

project_numberintegerrequired

The project's number.

usernamestringrequired

The handle for the GitHub user account.

4 status codes

200Response

idnumberrequired

The unique identifier of the project.

node_idstringrequired

The node ID of the project.

ownerobjectrequired

A GitHub user.

creatorobjectrequired

A GitHub user.

titlestringrequired

The project title.

descriptionstringrequired

A short description of the project.

publicbooleanrequired

Whether the project is visible to anyone with access to the owner.

closed_atstringrequired

The time when the project was closed.

created_atstringrequired

The time when the project was created.

updated_atstringrequired

The time when the project was last updated.

numberintegerrequired

The project number.

short_descriptionstringrequired

A concise summary of the project.

deleted_atstringrequired

The time when the project was deleted.

deleted_byobjectrequired

A GitHub user.

statestringoptional

The current state of the project.

Allowed:openclosed

latest_status_updateobjectoptional

An status update belonging to a project

is_templatebooleanoptional

Whether this project is a template

304Not modified

401Requires authentication

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

403Forbidden

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 401 is returned: Requires authentication. A 403 is returned: Forbidden.

import { Client } from "octri-github";

const client = new Client({
  baseUrl: "https://api.github.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.projectsV2.get({
  username: "octocat",
  projectNumber: "example",
});

{
  "id": 2,
  "node_id": "MDc6UHJvamVjdDEwMDI2MDM=",
  "owner": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "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}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "creator": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "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}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "title": "My Projects",
  "description": "A board to manage my personal projects.",
  "public": true,
  "closed_at": null,
  "created_at": "2011-04-10T20:09:31Z",
  "updated_at": "2014-03-03T18:58:10Z",
  "number": 2,
  "short_description": null,
  "deleted_at": null,
  "deleted_by": null,
  "state": "open",
  "latest_status_update": {
    "id": 3,
    "node_id": "PVTSU_lAECAQM",
    "creator": {
      "login": "hubot",
      "id": 2,
      "node_id": "MDQ6VXNlcjI=",
      "avatar_url": "https://github.com/images/error/hubot_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/hubot",
      "html_url": "https://github.com/hubot",
      "followers_url": "https://api.github.com/users/hubot/followers",
      "following_url": "https://api.github.com/users/hubot/following{/other_user}",
      "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/hubot/subscriptions",
      "organizations_url": "https://api.github.com/users/hubot/orgs",
      "repos_url": "https://api.github.com/users/hubot/repos",
      "events_url": "https://api.github.com/users/hubot/events{/privacy}",
      "received_events_url": "https://api.github.com/users/hubot/received_events",
      "type": "User",
      "site_admin": false
    },
    "body": "DONE",
    "start_date": "2025-07-23",
    "target_date": "2025-07-26",
    "status": "COMPLETE",
    "created_at": "2025-07-11T16:19:28Z",
    "updated_at": "2025-07-11T16:19:28Z"
  },
  "is_template": true
}

Was this helpful?

Request

Response

Errors