---
title: "Get all checkout keys"
method: GET
path: "/project/{project-slug}/checkout-key"
tags: ["Project"]
---

# Get all checkout keys

`GET /project/{project-slug}/checkout-key`

## Request

- Base URL: `https://circleci.com/api/v2`
- URL: `https://circleci.com/api/v2/project/{project-slug}/checkout-key`
- Auth: one of:
  - API key in header `Circle-Token`
  - HTTP bearer
  - HTTP basic
  - API key in query parameter `circle-token`

Returns a sequence of checkout keys for `:project`.

## Path parameters

- `project-slug` string, required

## Query parameters

- `digest` 'sha256' | 'md5'

## Response `200`

A sequence of checkout keys.

- object
  - `items` object[], required
    - `public-key` string, required: A public SSH key.
    - `type` 'deploy-key' | 'github-user-key', required: The type of checkout key. This may be either `deploy-key` or `github-user-key`.
    - `fingerprint` string, required: An SSH key fingerprint.
    - `preferred` boolean, required: A boolean value that indicates if this key is preferred.
    - `created-at` string, date-time, required: The date and time the checkout key was created.
  - `next_page_token` string, required: A token to pass as a `page-token` query parameter to return the next page of results.

## Other responses

- `default`: Error response.

---

[API](https://skmtc.dev/circleci/apis/circleci-api.md) - [All operations](https://skmtc.dev/circleci/apis/circleci-api/llms.txt) - [OpenAPI document](https://skmtc.dev/circleci/apis/circleci-api/revisions/b9c0e0c24058?raw)