CIcircleci
Project

Get a project

Retrieves a project by project slug.

get/project/{project-slug}

Request

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

Path parameters

project-slugstring 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).

Response

A project object

slugstring 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).

namestring required

The name of the project

idstring uuid required
organization_namestring required

The name of the organization the project belongs to

organization_slugstring required

The slug of the organization the project belongs to

organization_idstring uuid required

The id of the organization the project belongs to

Example response

{
  "slug": "gh/CircleCI-Public/api-preview-docs",
  "name": "api-preview-docs",
  "organization_name": "CircleCI-Public",
  "organization_slug": "gh/CircleCI-Public",
  "organization_id": "ec6887ec-7d44-4b31-b468-7e552408ee32",
  "vcs_info": {
    "vcs_url": "https://github.com/CircleCI-Public/api-preview-docs",
    "default_branch": "main"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.