CircleCI Logo
Navigation Menu Icon

How to find IDs

Language Icon 2 months ago · 9 min read
Cloud
Contribute Go to Code

You may need to find the ID of specific CircleCI elements to perform various actions, including:

  • Making a request to the CircleCI API.

  • Running a command from the local CircleCI CLI.

  • Identifying a CircleCI element in logs or webhook payloads.

This guide covers finding IDs in the CircleCI web app, or from environment variables. It is also possible to find IDs via the CircleCI APIs.

Get IDs from the built-in environment variables

Buit-in environment variables, scoped at the job level, include the following IDs:

  • CIRCLE_ORGANIZATION_ID: The organization ID.

  • CIRCLE_PROJECT_ID: The project ID.

  • CIRCLE_PIPELINE_ID: The pipeline ID.

  • CIRCLE_WORKFLOW_ID: The workflow ID.

  • CIRCLE_WORKFLOW_JOB_ID: The job ID.

To view all environment variables available at the job level, follow these steps:

  1. In the CircleCI web app, select your org from the org cards on your user homepage.

  2. Select Projects from the sidebar and locate your project from the list. You can use the search to help.

  3. Select the Pipelines next to your project.

  4. Expand a workflow run.

  5. Select a job from that workflow run.

  6. On the job page, expand the Preparing environment variables step.

  7. Locate the relevant environment variable(s) and note the associated value(s).

IDs available from built-in environment variables

Find your user ID

The user ID is a unique identifier for a user. Follow these steps to find it in the CircleCI web app:

  1. In the CircleCI application, go to your User settings.

  2. On the Account Integrations page, locate the User ID label.

  3. Note the value or select the Copy icon next to your user ID.

Find an organization ID

The organization ID is a unique identifier for an organization.

You can access the organization ID through the CIRCLE_ORGANIZATION_ID built-in environment variable. Alternatively, follow these steps to find it in the CircleCI web app:

  1. In the CircleCI web app, select your org from the org cards on your user homepage.

  2. Navigate to Organization Settings  Overview in the CircleCI web app.

  3. Note the value or select the Copy icon next to the organization ID.

Find a project ID

The project ID is a unique identifier for a project.

You can access the project ID through the CIRCLE_PROJECT_ID built-in environment variable. Alternatively, follow these steps to find it in the CircleCI web app:

  1. In the CircleCI web app, select your org from the org cards on your user homepage.

  2. Select Projects from the sidebar and locate your project from the list. You can use the search to help.

  3. Select the ellipsis more icon next to your project and select Project Settings.

    You can also access project settings from each project overview page using the Settings button.

  4. On the Overview page, note the value or select the Copy icon next to the project ID.

Find a pipeline ID

The pipeline ID is a unique identifier for a pipeline that has been triggered.

You can access the pipeline ID through the CIRCLE_PIPELINE_ID built-in environment variable. Alternatively, follow these steps to find it in the CircleCI web app:

  • From the pipelines dashboard

  • From the workflow page

  • From the job page

  1. In the CircleCI web app, select your org from the org cards on your user homepage.

  2. Select Projects from the sidebar and locate your project from the list. You can use the search to help.

  3. Select the Pipelines next to your project.

  4. Select the ellipsis more icon next to any workflow run of the pipeline.

  5. In the contextual menu, select Copy Pipeline ID.

Copy pipeline ID from pipelines dashboard

  1. In the CircleCI web app, select your org from the org cards on your user homepage.

  2. Select Projects from the sidebar and locate your project from the list. You can use the search to help.

  3. Select the Pipelines next to your project.

  4. Select any workflow run of the pipeline you want to find the ID for.

  5. On the workflow page, select the ellipsis more icon at the top-right of the page (next to the Rerun button).

  6. In the contextual menu, select Copy Pipeline ID.

Copy pipeline ID from workflow page

  1. In the CircleCI web app, select your org from the org cards on your user homepage.

  2. Select Projects from the sidebar and locate your project from the list. You can use the search to help.

  3. Select the Pipelines next to your project.

  4. Select any workflow run from the pipeline you want to find the ID for.

  5. Select any job from that workflow run.

  6. On the job page, select the ellipsis more icon at the top-right of the page (next to the Rerun button).

  7. In the contextual menu, select Copy Pipeline ID.

Copy pipeline ID from job page

Find a workflow ID

The workflow ID is a unique identifier for a workflow that has been triggered.

You can access the workflow ID through the CIRCLE_WORKFLOW_ID built-in environment variable. Alternatively, follow these steps to find it in the CircleCI web app:

  • From the workflow URL

  • From the job URL

  1. In the CircleCI web app, select your org from the org cards on your user homepage.

  2. Select Projects from the sidebar and locate your project from the list. You can use the search to help.

  3. Select the Pipelines next to your project.

  4. Select the workflow run you want to find the ID for.

  5. Check the URL of the page. The workflow ID is the last alphanumeric string of the URL, after the /workflows/ string.

Get workflow ID from workflow page URL

  1. In the CircleCI web app, select your org from the org cards on your user homepage.

  2. Select Projects from the sidebar and locate your project from the list. You can use the search to help.

  3. Select the Pipelines next to your project.

  4. Select the workflow run you want to find the ID for.

  5. Select any job from that workflow run.

  6. Check the URL of the page. The workflow ID is the alphanumeric string of the URL located between the /workflows/ and the /jobs/ strings.

Get workflow ID from job page URL

Find a pipeline definition ID

The pipeline definition ID is a unique identifier for a pipeline definition. Follow these steps to find it in the CircleCI web app:

  1. In the CircleCI web app, select your org from the org cards on your user homepage.

  2. Select Projects from the sidebar and locate your project from the list. You can use the search to help.

  3. Select the ellipsis more icon next to your project and select Project Settings.

    You can also access project settings from each project overview page using the Settings button.

  4. Navigate to the Project Setup page.

  5. Locate the pipeline definition you want to find the ID for.

  6. Note the value below the pipeline name or select the Copy icon next to the pipeline definition ID.

Get pipeline definition ID