List repositories for a user | Sample

6 parameters

usernamestringrequired

The handle for the GitHub user account.

typestringoptional

Limit results to repositories of the specified type.

Allowed:allownermemberDefault:owner

sortstringoptional

The property to sort the results by.

Allowed:createdupdatedpushedfull_nameDefault:full_name

directionstringoptional

The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.

Allowed:ascdesc

per_pageintegeroptional

The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."

Default:30

pageintegeroptional

The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."

Default:1

1 status code

200Response

idintegerrequired

node_idstringrequired

namestringrequired

full_namestringrequired

ownerobjectrequired

A GitHub user.

privatebooleanrequired

html_urlstringrequired

descriptionstringrequired

forkbooleanrequired

urlstringrequired

archive_urlstringrequired

assignees_urlstringrequired

blobs_urlstringrequired

branches_urlstringrequired

collaborators_urlstringrequired

comments_urlstringrequired

commits_urlstringrequired

compare_urlstringrequired

contents_urlstringrequired

contributors_urlstringrequired

deployments_urlstringrequired

downloads_urlstringrequired

events_urlstringrequired

forks_urlstringrequired

git_commits_urlstringrequired

git_refs_urlstringrequired

git_tags_urlstringrequired

git_urlstringoptional

issue_comment_urlstringrequired

issue_events_urlstringrequired

issues_urlstringrequired

keys_urlstringrequired

labels_urlstringrequired

languages_urlstringrequired

merges_urlstringrequired

milestones_urlstringrequired

notifications_urlstringrequired

pulls_urlstringrequired

releases_urlstringrequired

ssh_urlstringoptional

stargazers_urlstringrequired

statuses_urlstringrequired

subscribers_urlstringrequired

subscription_urlstringrequired

tags_urlstringrequired

teams_urlstringrequired

trees_urlstringrequired

clone_urlstringoptional

mirror_urlstringoptional

hooks_urlstringrequired

svn_urlstringoptional

homepagestringoptional

languagestringoptional

forks_countintegeroptional

stargazers_countintegeroptional

watchers_countintegeroptional

sizeintegeroptional

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

default_branchstringoptional

open_issues_countintegeroptional

is_templatebooleanoptional

topicsarray<string>optional

has_issuesbooleanoptional

has_projectsbooleanoptional

has_wikibooleanoptional

has_pagesbooleanoptional

has_downloadsbooleanoptional

has_discussionsbooleanoptional

has_pull_requestsbooleanoptional

pull_request_creation_policystringoptional

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

Allowed:allcollaborators_only

archivedbooleanoptional

disabledbooleanoptional

visibilitystringoptional

pushed_atstringoptional

created_atstringoptional

updated_atstringoptional

permissionsobjectoptional

role_namestringoptional

temp_clone_tokenstringoptional

delete_branch_on_mergebooleanoptional

subscribers_countintegeroptional

network_countintegeroptional

code_of_conductobjectoptional

Code Of Conduct

licenseobjectoptional

forksintegeroptional

open_issuesintegeroptional

watchersintegeroptional

allow_forkingbooleanoptional

web_commit_signoff_requiredbooleanoptional

security_and_analysisobjectoptional

custom_propertiesobjectoptional

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.

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.repos.list({
  username: "octocat",
  type: "example",
  sort: "example",
  direction: "example",
  perPage: 20,
});

[
  {
    "id": 1296269,
    "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
    "name": "Hello-World",
    "full_name": "octocat/Hello-World",
    "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
    },
    "private": false,
    "html_url": "https://github.com/octocat/Hello-World",
    "description": "This your first repo!",
    "fork": false,
    "url": "https://api.github.com/repos/octocat/Hello-World",
    "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
    "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
    "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
    "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
    "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
    "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
    "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
    "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
    "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
    "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
    "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
    "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
    "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
    "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
    "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
    "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
    "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
    "git_url": "git:github.com/octocat/Hello-World.git",
    "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
    "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
    "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
    "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
    "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
    "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
    "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
    "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
    "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
    "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
    "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
    "ssh_url": "git@github.com:octocat/Hello-World.git",
    "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
    "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
    "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
    "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
    "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
    "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
    "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
    "clone_url": "https://github.com/octocat/Hello-World.git",
    "mirror_url": "git:git.example.com/octocat/Hello-World",
    "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
    "svn_url": "https://svn.github.com/octocat/Hello-World",
    "homepage": "https://github.com",
    "language": null,
    "forks_count": 9,
    "stargazers_count": 80,
    "watchers_count": 80,
    "size": 108,
    "default_branch": "master",
    "open_issues_count": 0,
    "is_template": false,
    "topics": [
      "octocat",
      "atom",
      "electron",
      "api"
    ],
    "has_issues": true,
    "has_projects": true,
    "has_wiki": true,
    "has_pages": false,
    "has_downloads": true,
    "has_discussions": false,
    "archived": false,
    "disabled": false,
    "visibility": "public",
    "pushed_at": "2011-01-26T19:06:43Z",
    "created_at": "2011-01-26T19:01:12Z",
    "updated_at": "2011-01-26T19:14:43Z",
    "permissions": {
      "admin": false,
      "push": false,
      "pull": true
    },
    "security_and_analysis": {
      "advanced_security": {
        "status": "enabled"
      },
      "secret_scanning": {
        "status": "enabled"
      },
      "secret_scanning_push_protection": {
        "status": "disabled"
      },
      "secret_scanning_non_provider_patterns": {
        "status": "disabled"
      },
      "secret_scanning_delegated_alert_dismissal": {
        "status": "disabled"
      }
    }
  }
]

Was this helpful?

Request

Response