List public keys for a user | Sample

3 parameters

usernamestringrequired

The handle for the GitHub user account.

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

keystringrequired

created_atstringoptional

last_usedstringoptional

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.keys.list({
  username: "octocat",
  perPage: 20,
  page: 1,
});

[
  {
    "id": 1,
    "key": "ssh-rsa AAA..."
  }
]

Was this helpful?