---
title: "Get a project"
method: GET
path: "/project/{project-slug}"
tags: ["Project"]
---

# Get a project

`GET /project/{project-slug}`

## Request

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

Retrieves a project by project slug.

## Path parameters

- `project-slug` string, required

## Response `200`

A project object

- object: NOTE: The definition of Project is subject to change.
  - `slug` string, required: Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings).
  - `name` string, required: The name of the project
  - `id` string, uuid, required
  - `organization_name` string, required: The name of the organization the project belongs to
  - `organization_slug` string, required: The slug of the organization the project belongs to
  - `organization_id` string, uuid, required: The id of the organization the project belongs to
  - `vcs_info` object, required: Information about the VCS that hosts the project source code.
    - `vcs_url` string, required: URL to the repository hosting the project's code
    - `provider` 'Bitbucket' | 'CircleCI' | 'GitHub', required: The VCS provider
    - `default_branch` string, required

## 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)