List packages for a user

GET

/users/{username}/packages

Lists all packages in a user’s namespace for which the requesting user has access.

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see “About permissions for GitHub Packages.”

API method documentation

Parameters

Path Parameters

username

required

string

The handle for the GitHub user account.

Query Parameters

package_type

required

string

Allowed values: npm maven rubygems docker nuget container

The type of supported package. Packages in GitHub’s Gradle registry have the type maven. Docker images pushed to GitHub’s Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub’s Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

visibility

string

Allowed values: public private internal

The selected visibility of the packages. This parameter is optional and only filters an existing result set.

The internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private. For the list of GitHub Packages registries that support granular permissions, see “About permissions for GitHub Packages.”

page

integer

default: 1

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

per_page

integer

default: 30

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

Responses

200

Response

application/json

Array<object>

Package

A software package

object

required

Unique identifier of the package.

integer

name

required

The name of the package.

string

package_type

required

string

Allowed values: npm maven rubygems docker nuget container

url

required

string

html_url

required

string

version_count

required

The number of versions of the package.

integer

visibility

required

string

Allowed values: private public

owner

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

repository

Minimal Repository

Minimal Repository

object

required

integer format: int64

node_id

required

string

name

required

string

full_name

required

string

owner

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

private

required

boolean

html_url

required

string format: uri

description

required

string

nullable

fork

required

boolean

url

required

string format: uri

archive_url

required

string

assignees_url

required

string

blobs_url

required

string

branches_url

required

string

collaborators_url

required

string

comments_url

required

string

commits_url

required

string

compare_url

required

string

contents_url

required

string

contributors_url

required

string format: uri

deployments_url

required

string format: uri

downloads_url

required

string format: uri

events_url

required

string format: uri

forks_url

required

string format: uri

git_commits_url

required

string

git_refs_url

required

string

git_tags_url

required

string

git_url

string

issue_comment_url

required

string

issue_events_url

required

string

issues_url

required

string

keys_url

required

string

labels_url

required

string

languages_url

required

string format: uri

merges_url

required

string format: uri

milestones_url

required

string

notifications_url

required

string

pulls_url

required

string

releases_url

required

string

ssh_url

string

stargazers_url

required

string format: uri

statuses_url

required

string

subscribers_url

required

string format: uri

subscription_url

required

string format: uri

tags_url

required

string format: uri

teams_url

required

string format: uri

trees_url

required

string

clone_url

string

mirror_url

string

nullable

hooks_url

required

string format: uri

svn_url

string

homepage

string

nullable

language

string

nullable

forks_count

integer

stargazers_count

integer

watchers_count

integer

size

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

integer

default_branch

string

open_issues_count

integer

is_template

boolean

topics

Array<string>

has_issues

boolean

has_projects

boolean

has_wiki

boolean

has_pages

boolean

has_downloads

boolean

has_discussions

boolean

has_pull_requests

boolean

pull_request_creation_policy

The policy controlling who can create pull requests: all or collaborators_only.

string

Allowed values: all collaborators_only

archived

boolean

disabled

boolean

visibility

string

pushed_at

string format: date-time

nullable

created_at

string format: date-time

nullable

updated_at

string format: date-time

nullable

permissions

object

admin

boolean

maintain

boolean

push

boolean

triage

boolean

pull

boolean

role_name

string

temp_clone_token

string

delete_branch_on_merge

boolean

subscribers_count

integer

network_count

integer

code_of_conduct

Code Of Conduct

Code Of Conduct

object

key

required

string

name

required

string

url

required

string format: uri

body

string

html_url

required

string format: uri

nullable

license

object

key

string

name

string

spdx_id

string

url

string

nullable

node_id

string

forks

integer

open_issues

integer

watchers

integer

allow_forking

boolean

web_commit_signoff_required

boolean

security_and_analysis

object

advanced_security

Enable or disable GitHub Advanced Security for the repository.

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

object

status

string

Allowed values: enabled disabled

code_security

object

status

string

Allowed values: enabled disabled

dependabot_security_updates

Enable or disable Dependabot security updates for the repository.

object

status

The enablement status of Dependabot security updates for the repository.

string

Allowed values: enabled disabled

secret_scanning

object

status

string

Allowed values: enabled disabled

secret_scanning_push_protection

object

status

string

Allowed values: enabled disabled

secret_scanning_non_provider_patterns

object

status

string

Allowed values: enabled disabled

secret_scanning_ai_detection

object

status

string

Allowed values: enabled disabled

secret_scanning_delegated_alert_dismissal

object

status

string

Allowed values: enabled disabled

secret_scanning_delegated_bypass

object

status

string

Allowed values: enabled disabled

secret_scanning_delegated_bypass_options

object

reviewers

The bypass reviewers for secret scanning delegated bypass

Array<object>

object

reviewer_id

required

The ID of the team or role selected as a bypass reviewer

integer

reviewer_type

required

The type of the bypass reviewer

string

Allowed values: TEAM ROLE

mode

The bypass mode for the reviewer

string

default: ALWAYS

Allowed values: ALWAYS EXEMPT

custom_properties

The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.

object

key

additional properties

any

created_at

required

string format: date-time

updated_at

required

string format: date-time

Examples

default

[
  {
    "id": 197,
    "name": "hello_docker",
    "package_type": "container",
    "owner": {
      "login": "octocat",
      "id": 9919,
      "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
      "avatar_url": "https://avatars.octocatusercontent.com/u/9919?v=4",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/github",
      "followers_url": "https://api.github.com/users/github/followers",
      "following_url": "https://api.github.com/users/github/following{/other_user}",
      "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/github/subscriptions",
      "organizations_url": "https://api.github.com/users/github/orgs",
      "repos_url": "https://api.github.com/users/github/repos",
      "events_url": "https://api.github.com/users/github/events{/privacy}",
      "received_events_url": "https://api.github.com/users/github/received_events",
      "type": "User",
      "site_admin": false
    },
    "version_count": 1,
    "visibility": "private",
    "url": "https://api.github.com/orgs/github/packages/container/hello_docker",
    "created_at": "2020-05-19T22:19:11Z",
    "updated_at": "2020-05-19T22:19:11Z",
    "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker"
  },
  {
    "id": 198,
    "name": "goodbye_docker",
    "package_type": "container",
    "owner": {
      "login": "github",
      "id": 9919,
      "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
      "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/github",
      "followers_url": "https://api.github.com/users/github/followers",
      "following_url": "https://api.github.com/users/github/following{/other_user}",
      "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/github/subscriptions",
      "organizations_url": "https://api.github.com/users/github/orgs",
      "repos_url": "https://api.github.com/users/github/repos",
      "events_url": "https://api.github.com/users/github/events{/privacy}",
      "received_events_url": "https://api.github.com/users/github/received_events",
      "type": "User",
      "site_admin": false
    },
    "version_count": 2,
    "visibility": "private",
    "url": "https://api.github.com/user/octocat/packages/container/goodbye_docker",
    "created_at": "2020-05-20T22:19:11Z",
    "updated_at": "2020-05-20T22:19:11Z",
    "html_url": "https://github.com/user/octocat/packages/container/package/goodbye_docker"
  }
]

400

The value of per_page multiplied by page cannot be greater than 10000.

401

Requires authentication

application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

403

Forbidden

application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

List packages for a user

Parameters

Path Parameters

Query Parameters

Responses

200

Examples

400

401

Example generated

403

Example generated

Example ^generated

Example ^generated