# CircleCI API API

> CircleCI API API on Apizie: 78 endpoints (List contexts, Create a new context, Get a context, Delete a context, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/open-data:circleci/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:circleci`
- Category: Open Data
- Status: byok
- Source: https://circleci.com
- Page: https://zieapi.vercel.app/api/open-data/circleci
- OpenAPI: https://zieapi.vercel.app/api/open-data/circleci/openapi.json

This describes the resources that make up the CircleCI API v2.

## Endpoints

### List contexts
`GET https://zieapi.vercel.app/v1/open-data:circleci/context-list-owner-contexts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner-id | string | no | The unique ID of the owner of the context. Specify either this or owner-slug. |
| owner-slug | string | no | A string that represents an organization. Specify either this or owner-id. Cannot be used for accounts. |
| owner-type | string | no | The type of the owner. Defaults to "organization". Accounts are only used as context owners in server. |
| page-token | string | no | A token to retrieve the next page of results. |

### Create a new context
`POST https://zieapi.vercel.app/v1/open-data:circleci/context-create-new-context` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get a context
`GET https://zieapi.vercel.app/v1/open-data:circleci/context-get-information` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| context-id | string | yes | ID of the context (UUID) |

### Delete a context
`POST https://zieapi.vercel.app/v1/open-data:circleci/context-remove-context` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| context-id | string | yes | ID of the context (UUID) |

### List environment variables
`GET https://zieapi.vercel.app/v1/open-data:circleci/context-list-environment-variables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| context-id | string | yes | ID of the context (UUID) |
| page-token | string | no | A token to retrieve the next page of results. |

### Add or update an environment variable
`POST https://zieapi.vercel.app/v1/open-data:circleci/context-update-environment-variable` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| context-id | string | yes | ID of the context (UUID) |
| env-var-name | string | yes | The name of the environment variable |
| body | object | no | JSON request body |

### Remove an environment variable
`POST https://zieapi.vercel.app/v1/open-data:circleci/context-remove-environment-variable` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| env-var-name | string | yes | The name of the environment variable |
| context-id | string | yes | ID of the context (UUID) |

### Get summary metrics and trends for a project across it's workflows and branches
`GET https://zieapi.vercel.app/v1/open-data:circleci/insights-get-project-summary-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |
| reporting-window | string | no | The time window used to calculate summary metrics. If not provided, defaults to last-90-days |
| branches | object | no | The names of VCS branches to include in branch-level workflow metrics. |
| workflow-names | object | no | The names of workflows to include in workflow-level metrics. |

### Job timeseries data
`GET https://zieapi.vercel.app/v1/open-data:circleci/insights-get-job-timeseries-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |
| workflow-name | string | yes | The name of the workflow. |
| branch | string | no | The name of a vcs branch. If not passed we will scope the API call to the default branch. |
| granularity | string | no | The granularity for which to query timeseries data. |
| start-date | string | no | Include only executions that started at or after this date. This must be specified if an end-date is provided. |
| end-date | string | no | Include only executions that started before this date. This date can be at most 90 days after the start-date. |

### Get summary metrics with trends for the entire org, and for each project.
`GET https://zieapi.vercel.app/v1/open-data:circleci/insights-get-summary-metrics-with-trends` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org-slug | string | yes | Org slug in the form `vcs-slug/org-name`. The `/` characters may be URL-escaped. |
| reporting-window | string | no | The time window used to calculate summary metrics. If not provided, defaults to last-90-days |
| project-names | object | no | List of project names. |

### Get all branches for a project
`GET https://zieapi.vercel.app/v1/open-data:circleci/insights-list-project-branches` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |
| workflow-name | string | no | The name of a workflow. If not passed we will scope the API call to the project. |

### Get flaky tests for a project
`GET https://zieapi.vercel.app/v1/open-data:circleci/insights-get-flaky-tests` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |

### Get summary metrics for a project's workflows
`GET https://zieapi.vercel.app/v1/open-data:circleci/insights-get-project-workflow-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |
| page-token | string | no | A token to retrieve the next page of results. |
| all-branches | boolean | no | Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter. |
| branch | string | no | The name of a vcs branch. If not passed we will scope the API call to the default branch. |
| reporting-window | string | no | The time window used to calculate summary metrics. If not provided, defaults to last-90-days |

### Get recent runs of a workflow
`GET https://zieapi.vercel.app/v1/open-data:circleci/insights-get-recent-workflow-runs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |
| workflow-name | string | yes | The name of the workflow. |
| all-branches | boolean | no | Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter. |
| branch | string | no | The name of a vcs branch. If not passed we will scope the API call to the default branch. |
| page-token | string | no | A token to retrieve the next page of results. |
| start-date | string | no | Include only executions that started at or after this date. This must be specified if an end-date is provided. |
| end-date | string | no | Include only executions that started before this date. This date can be at most 90 days after the start-date. |

### Get summary metrics for a project workflow's jobs.
`GET https://zieapi.vercel.app/v1/open-data:circleci/insights-get-project-workflow-job-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |
| workflow-name | string | yes | The name of the workflow. |
| page-token | string | no | A token to retrieve the next page of results. |
| all-branches | boolean | no | Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter. |
| branch | string | no | The name of a vcs branch. If not passed we will scope the API call to the default branch. |
| reporting-window | string | no | The time window used to calculate summary metrics. If not provided, defaults to last-90-days |

### Get metrics and trends for workflows
`GET https://zieapi.vercel.app/v1/open-data:circleci/insights-get-workflow-summary-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |
| workflow-name | string | yes | The name of the workflow. |
| all-branches | boolean | no | Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter. |
| branch | string | no | The name of a vcs branch. If not passed we will scope the API call to the default branch. |

### Get test metrics for a project's workflows
`GET https://zieapi.vercel.app/v1/open-data:circleci/insights-get-project-workflow-test-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |
| workflow-name | string | yes | The name of the workflow. |
| branch | string | no | The name of a vcs branch. If not passed we will scope the API call to the default branch. |
| all-branches | boolean | no | Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter. |

### User Information
`GET https://zieapi.vercel.app/v1/open-data:circleci/user-get-information` (byok)

### Collaborations
`GET https://zieapi.vercel.app/v1/open-data:circleci/user-list-collaborations` (byok)

### Get a list of pipelines
`GET https://zieapi.vercel.app/v1/open-data:circleci/pipeline-list-recent-pipelines` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org-slug | string | no | Org slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the… |
| page-token | string | no | A token to retrieve the next page of results. |
| mine | boolean | no | Only include entries created by your user. |

### Continue a pipeline
`POST https://zieapi.vercel.app/v1/open-data:circleci/pipeline-continue-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get a pipeline by ID
`GET https://zieapi.vercel.app/v1/open-data:circleci/pipeline-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pipeline-id | string | yes | The unique ID of the pipeline. |

### Get a pipeline's configuration
`GET https://zieapi.vercel.app/v1/open-data:circleci/pipeline-get-configuration-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pipeline-id | string | yes | The unique ID of the pipeline. |

### Get a pipeline's workflows
`GET https://zieapi.vercel.app/v1/open-data:circleci/pipeline-list-workflows` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pipeline-id | string | yes | The unique ID of the pipeline. |
| page-token | string | no | A token to retrieve the next page of results. |

### Get a project
`GET https://zieapi.vercel.app/v1/open-data:circleci/project-get-by-slug` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |

### Get all checkout keys
`GET https://zieapi.vercel.app/v1/open-data:circleci/project-list-checkout-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |
| digest | string | no | The fingerprint digest type to return. This may be either `md5` or `sha256`. If not passed, defaults to `md5`. |

### Create a new checkout key
`POST https://zieapi.vercel.app/v1/open-data:circleci/project-create-checkout-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |
| body | object | no | JSON request body |

### Get a checkout key
`GET https://zieapi.vercel.app/v1/open-data:circleci/project-get-checkout-key-by-fingerprint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |
| fingerprint | string | yes | An SSH key fingerprint. |

### Delete a checkout key
`POST https://zieapi.vercel.app/v1/open-data:circleci/project-delete-checkout-key-by-fingerprint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |
| fingerprint | string | yes | An SSH key fingerprint. |

### List all environment variables
`GET https://zieapi.vercel.app/v1/open-data:circleci/project-list-env-var-values` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |

### Create an environment variable
`POST https://zieapi.vercel.app/v1/open-data:circleci/project-create-env-var` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |
| body | object | no | JSON request body |

### Get a masked environment variable
`GET https://zieapi.vercel.app/v1/open-data:circleci/project-get-masked-env-var` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |
| name | string | yes | The name of the environment variable. |

### Delete an environment variable
`POST https://zieapi.vercel.app/v1/open-data:circleci/project-delete-environment-variable` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |
| name | string | yes | The name of the environment variable. |

### Get job details
`GET https://zieapi.vercel.app/v1/open-data:circleci/job-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| job-number | string | yes | The number of the job. |
| project-slug | string | yes | 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,… |

### Cancel job
`POST https://zieapi.vercel.app/v1/open-data:circleci/job-cancel-with-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| job-number | string | yes | The number of the job. |
| project-slug | string | yes | 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,… |

### Get all pipelines
`GET https://zieapi.vercel.app/v1/open-data:circleci/pipeline-get-all-pipelines` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |
| branch | string | no | The name of a vcs branch. |
| page-token | string | no | A token to retrieve the next page of results. |

### Trigger a new pipeline
`POST https://zieapi.vercel.app/v1/open-data:circleci/pipeline-trigger-new-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |
| body | object | no | JSON request body |

### Get your pipelines
`GET https://zieapi.vercel.app/v1/open-data:circleci/pipeline-list-user-pipelines` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |
| page-token | string | no | A token to retrieve the next page of results. |

### Get a pipeline by pipeline number
`GET https://zieapi.vercel.app/v1/open-data:circleci/pipeline-get-by-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |
| pipeline-number | string | yes | The number of the pipeline. |

### Get all schedules
`GET https://zieapi.vercel.app/v1/open-data:circleci/schedule-get-all-schedules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |
| page-token | string | no | A token to retrieve the next page of results. |

### Create a schedule
`POST https://zieapi.vercel.app/v1/open-data:circleci/schedule-create-new-schedule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project-slug | string | yes | 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,… |
| body | object | no | JSON request body |

### Get a job's artifacts
`GET https://zieapi.vercel.app/v1/open-data:circleci/job-get-artifacts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| job-number | string | yes | The number of the job. |
| project-slug | string | yes | 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,… |

### Get test metadata
`GET https://zieapi.vercel.app/v1/open-data:circleci/job-get-test-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| job-number | string | yes | The number of the job. |
| project-slug | string | yes | 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,… |

### Get a schedule
`GET https://zieapi.vercel.app/v1/open-data:circleci/schedule-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| schedule-id | string | yes | The unique ID of the schedule. |

### Update a schedule
`POST https://zieapi.vercel.app/v1/open-data:circleci/schedule-update-schedule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| schedule-id | string | yes | The unique ID of the schedule. |
| body | object | no | JSON request body |

### Delete a schedule
`POST https://zieapi.vercel.app/v1/open-data:circleci/schedule-remove-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| schedule-id | string | yes | The unique ID of the schedule. |

### User Information
`GET https://zieapi.vercel.app/v1/open-data:circleci/user-get-user-information` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The unique ID of the user. |

### List webhooks
`GET https://zieapi.vercel.app/v1/open-data:circleci/webhook-list-matching-scope` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| scope-id | string | yes | ID of the scope being used (at the moment, only project ID is supported) |
| scope-type | string | yes | Type of the scope being used |

### Create an outbound webhook
`POST https://zieapi.vercel.app/v1/open-data:circleci/webhook-create-outbound-webhook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get a webhook
`GET https://zieapi.vercel.app/v1/open-data:circleci/webhook-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| webhook-id | string | yes | ID of the webhook (UUID) |

### Update an outbound webhook
`POST https://zieapi.vercel.app/v1/open-data:circleci/webhook-update-outbound-webhook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| webhook-id | string | yes | ID of the webhook (UUID) |
| body | object | no | JSON request body |

### Delete an outbound webhook
`POST https://zieapi.vercel.app/v1/open-data:circleci/webhook-delete-outbound-webhook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| webhook-id | string | yes | ID of the webhook (UUID) |

### Get a workflow
`GET https://zieapi.vercel.app/v1/open-data:circleci/workflow-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The unique ID of the workflow. |

### Approve a job
`POST https://zieapi.vercel.app/v1/open-data:circleci/workflow-approve-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| approval_request_id | string | yes | The ID of the job being approved. |
| id | string | yes | The unique ID of the workflow. |

### Cancel a workflow
`POST https://zieapi.vercel.app/v1/open-data:circleci/workflow-cancel-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The unique ID of the workflow. |

### Get a workflow's jobs
`GET https://zieapi.vercel.app/v1/open-data:circleci/workflow-get-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The unique ID of the workflow. |

### Rerun a workflow
`POST https://zieapi.vercel.app/v1/open-data:circleci/workflow-rerun-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The unique ID of the workflow. |
| body | object | no | JSON request body |

### Get org-level claims
`GET https://zieapi.vercel.app/v1/open-data:circleci/oidc-token-management-get-org-claims` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orgID | string | yes |  |

### Patch org-level claims
`POST https://zieapi.vercel.app/v1/open-data:circleci/oidc-token-management-update-org-claims` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orgID | string | yes |  |
| body | object | no | JSON request body |

### Delete org-level claims
`POST https://zieapi.vercel.app/v1/open-data:circleci/oidc-token-management-delete-org-claims` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orgID | string | yes |  |
| claims | string | yes | comma separated list of claims to delete. Valid values are "audience" and "ttl". |

### Get project-level claims
`GET https://zieapi.vercel.app/v1/open-data:circleci/oidc-token-management-get-project-claims` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orgID | string | yes |  |
| projectID | string | yes |  |

### Patch project-level claims
`POST https://zieapi.vercel.app/v1/open-data:circleci/oidc-token-management-update-project-claims` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orgID | string | yes |  |
| projectID | string | yes |  |
| body | object | no | JSON request body |

### Delete project-level claims
`POST https://zieapi.vercel.app/v1/open-data:circleci/oidc-token-management-delete-project-claims` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orgID | string | yes |  |
| projectID | string | yes |  |
| claims | string | yes | comma separated list of claims to delete. Valid values are "audience" and "ttl". |

### Retrieves the owner's decision audit logs.
`GET https://zieapi.vercel.app/v1/open-data:circleci/policy-management-get-decision-audit-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ownerID | string | yes |  |
| context | string | yes |  |
| status | string | no | Return decisions matching this decision status. |
| after | string | no | Return decisions made after this date. |
| before | string | no | Return decisions made before this date. |
| branch | string | no | Return decisions made on this branch. |
| project_id | string | no | Return decisions made for this project. |
| build_number | string | no | Return decisions made for this build number. |
| offset | integer | no | Sets the offset when retrieving the decisions, for paging. |

### Makes a decision
`POST https://zieapi.vercel.app/v1/open-data:circleci/policy-management-evaluate-input-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ownerID | string | yes |  |
| context | string | yes |  |
| body | object | no | JSON request body |

### Get the decision settings
`GET https://zieapi.vercel.app/v1/open-data:circleci/policy-management-get-decision-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ownerID | string | yes |  |
| context | string | yes |  |

### Set the decision settings
`POST https://zieapi.vercel.app/v1/open-data:circleci/policy-management-modify-decision-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ownerID | string | yes |  |
| context | string | yes |  |
| body | object | no | JSON request body |

### Retrieves the owner's decision audit log by given decisionID
`GET https://zieapi.vercel.app/v1/open-data:circleci/policy-management-get-decision-audit-log-by-given-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ownerID | string | yes |  |
| context | string | yes |  |
| decisionID | string | yes |  |

### Retrieves Policy Bundle for a given decision log ID
`GET https://zieapi.vercel.app/v1/open-data:circleci/policy-management-get-policy-bundle-for-decision` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ownerID | string | yes |  |
| context | string | yes |  |
| decisionID | string | yes |  |

### Retrieves Policy Bundle
`GET https://zieapi.vercel.app/v1/open-data:circleci/policy-management-get-policy-bundle` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ownerID | string | yes |  |
| context | string | yes |  |

### Creates policy bundle for the context
`POST https://zieapi.vercel.app/v1/open-data:circleci/policy-management-create-policy-bundle-for-context` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ownerID | string | yes |  |
| context | string | yes |  |
| dry | boolean | no |  |
| body | object | no | JSON request body |

### Retrieves a policy document
`GET https://zieapi.vercel.app/v1/open-data:circleci/policy-management-get-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ownerID | string | yes |  |
| context | string | yes |  |
| policyName | string | yes | the policy name set by the rego policy_name rule |

### 🧪 Get context restrictions
`GET https://zieapi.vercel.app/v1/open-data:circleci/context-get-restrictions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| context_id | string | yes | An opaque identifier of a context. |

### 🧪 Create context restriction
`POST https://zieapi.vercel.app/v1/open-data:circleci/context-create-restriction` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| context_id | string | yes | An opaque identifier of a context. |
| body | object | yes | JSON request body |

### 🧪 Delete context restriction
`POST https://zieapi.vercel.app/v1/open-data:circleci/context-delete-restriction` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| context_id | string | yes | An opaque identifier of a context. |
| restriction_id | string | yes | An opaque identifier of a context restriction. |

### 🧪 Create a project
`POST https://zieapi.vercel.app/v1/open-data:circleci/project-create-project-default-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| provider | string | yes | The `provider` segment of a project or org slug, the first of the three. This may be a VCS. For projects that use GitLab or GitHub App,… |
| organization | string | yes | The `organization` segment of a project or org slug, the second of the three. For GitHub OAuth or Bitbucket projects, this is the… |
| project | string | yes | The `project` segment of a project slug, the third of the three. For GitHub OAuth or Bitbucket projects, this is the repository name. For… |

### 🧪 Get project settings
`GET https://zieapi.vercel.app/v1/open-data:circleci/project-get-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| provider | string | yes | The `provider` segment of a project or org slug, the first of the three. This may be a VCS. For projects that use GitLab or GitHub App,… |
| organization | string | yes | The `organization` segment of a project or org slug, the second of the three. For GitHub OAuth or Bitbucket projects, this is the… |
| project | string | yes | The `project` segment of a project slug, the third of the three. For GitHub OAuth or Bitbucket projects, this is the repository name. For… |

### 🧪 Update project settings
`POST https://zieapi.vercel.app/v1/open-data:circleci/project-update-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| provider | string | yes | The `provider` segment of a project or org slug, the first of the three. This may be a VCS. For projects that use GitLab or GitHub App,… |
| organization | string | yes | The `organization` segment of a project or org slug, the second of the three. For GitHub OAuth or Bitbucket projects, this is the… |
| project | string | yes | The `project` segment of a project slug, the third of the three. For GitHub OAuth or Bitbucket projects, this is the repository name. For… |
| body | object | yes | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/open-data:circleci/context-list-owner-contexts" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the CircleCI API API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/open-data:circleci/context-list-owner-contexts with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the CircleCI API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. CircleCI API itself also needs your own key from circleci.com.

### Can AI agents use the CircleCI API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key open-data:circleci.

### What is the status of the CircleCI API API?
Needs your own provider key (bring your own key)