projects

List user projects

Lists projects for a user.

get/users/{username}/projects

Request

  • Base URL: http://HOSTNAME/api/v3
  • URL: http://HOSTNAME/api/v3/users/{username}/projects
  • Auth: none declared

Path parameters

usernamestring required

The handle for the GitHub user account.

Query parameters

state'open' | 'closed' | 'all'

Indicates the state of the projects to return.

per_pageinteger

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

pageinteger

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Response

Response

owner_urlstring uri required
urlstring uri required
html_urlstring uri required
columns_urlstring uri required
idinteger required
node_idstring required
namestring required

Name of the project

bodystring nullable required

Body of the project

numberinteger required
statestring required

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

created_atstring date-time required
updated_atstring date-time required
organization_permission'read' | 'write' | 'admin' | 'none'

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

privateboolean

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

Example response

[
  {
    "owner_url": "https://api.github.com/repos/api-playground/projects-test",
    "url": "https://api.github.com/projects/1002604",
    "html_url": "https://github.com/api-playground/projects-test/projects/12",
    "columns_url": "https://api.github.com/projects/1002604/columns",
    "id": 1002604,
    "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=",
    "name": "Week One Sprint",
    "body": "This project represents the sprint of the first week in January",
    "number": 1,
    "state": "open",
    "creator": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
      "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",
      "starred_at": "\"2020-07-09T00:17:55Z\""
    },
    "created_at": "2011-04-10T20:09:31Z",
    "updated_at": "2014-03-03T18:58:10Z"
  }
]

Changes

No recorded changes to this operation across all 50 revisions of this API.