CircleCI integration: operations for AI agents
CircleCI connects to Type.com as an integration. This page lists the 111 operations documented for Claude and Codex in Type.com: 61 read, 25 write, 25 destructive.
About CircleCI
CircleCI is a continuous integration and delivery platform that automates build, test, and deployment pipelines for software development.
Categories: Developer Tools & IT
How to connect CircleCI to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
111 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
111 operations listed.
Insights
- Read
Get summary metrics and trends for a project across it's workflows and branches
Get summary metrics and trends for a project at workflow and branch level. Workflow runs going back at most 90 days are included in the aggregation window. Trends are only supported upto last 30 days. Please note that Insights is not a financial reporting tool and should not be used for precise credit reporting. Credit reporting from Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI UI, nor does the underlying data have the same data accuracy guarantees as the billing information in the CircleCI UI. This may lead to discrepancies between credits reported from Insights and the billing information in the Plan Overview page of the CircleCI UI. For precise credit reporting, always use the Plan Overview page in the CircleCI UI.
GET /insights/pages/{project-slug}/summary - Read
Job timeseries data
Get timeseries data for all jobs within a workflow. Hourly granularity data is only retained for 48 hours while daily granularity data is retained for 90 days.
GET /insights/time-series/{project-slug}/workflows/{workflow-name}/jobs - Read
Get summary metrics with trends for the entire org, and for each project.
Gets aggregated summary metrics with trends for the entire org. Also gets aggregated metrics and trends for each project belonging to the org.
GET /insights/{org-slug}/summary - Read
Get all branches for a project
Get a list of all branches for a specified project. The list will only contain branches currently available within Insights. The maximum number of branches returned by this endpoint is 5,000.
GET /insights/{project-slug}/branches - Read
Get flaky tests for a project
Get a list of flaky tests for a given project. Flaky tests are branch agnostic. A flaky test is a test that passed and failed in the same commit.
GET /insights/{project-slug}/flaky-tests - Read
Get summary metrics for a project's workflows
Get summary metrics for a project's workflows. Workflow runs going back at most 90 days are included in the aggregation window. Metrics are refreshed daily, and thus may not include executions from the last 24 hours. Please note that Insights is not a financial reporting tool and should not be used for precise credit reporting. Credit reporting from Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI UI, nor does the underlying data have the same data accuracy guarantees as the billing information in the CircleCI UI. This may lead to discrepancies between credits reported from Insights and the billing information in the Plan Overview page of the CircleCI UI. For precise credit reporting, always use the Plan Overview page in the CircleCI UI.
GET /insights/{project-slug}/workflows - Read
Get recent runs of a workflow
Get recent runs of a workflow. Runs going back at most 90 days are returned. Please note that Insights is not a financial reporting tool and should not be used for precise credit reporting. Credit reporting from Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI UI, nor does the underlying data have the same data accuracy guarantees as the billing information in the CircleCI UI. This may lead to discrepancies between credits reported from Insights and the billing information in the Plan Overview page of the CircleCI UI. For precise credit reporting, always use the Plan Overview page in the CircleCI UI.
GET /insights/{project-slug}/workflows/{workflow-name} - Read
Get summary metrics for a project workflow's jobs.
Get summary metrics for a project workflow's jobs. Job runs going back at most 90 days are included in the aggregation window. Metrics are refreshed daily, and thus may not include executions from the last 24 hours. Please note that Insights is not a financial reporting tool and should not be used for precise credit reporting. Credit reporting from Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI UI, nor does the underlying data have the same data accuracy guarantees as the billing information in the CircleCI UI. This may lead to discrepancies between credits reported from Insights and the billing information in the Plan Overview page of the CircleCI UI. For precise credit reporting, always use the Plan Overview page in the CircleCI UI.
GET /insights/{project-slug}/workflows/{workflow-name}/jobs - Read
Get metrics and trends for workflows
Get the metrics and trends for a particular workflow on a single branch or all branches
GET /insights/{project-slug}/workflows/{workflow-name}/summary - Read
Get test metrics for a project's workflows
Get test metrics for a project's workflows. Currently tests metrics are calculated based on 10 most recent workflow runs.
GET /insights/{project-slug}/workflows/{workflow-name}/test-metrics
Job
- Read
Get a job
Gets a job's metadata by its unique ID, including its name, job number, type, status, and associated resource IDs.
GET /jobs/{job_id} - Destructive
Cancel job by job ID
Cancel job with a given job ID.
POST /jobs/{job-id}/cancel - Destructive
Cancel job by job number
Cancel job with a given job number.
POST /project/{project-slug}/job/{job-number}/cancel
User
- Read
User Information
Provides information about the user that is currently signed in.
GET /me - Read
Collaborations
Provides the set of organizations of which a user is a member or a collaborator. The set of organizations that a user can collaborate on is composed of: * Organizations that the current user belongs to across VCS types (e.g. BitBucket, GitHub) * The parent organization of repository that the user can collaborate on, but is not necessarily a member of * The organization of the current user's account
GET /me/collaborations - Read
User Information
Provides information about the user with the given ID.
GET /user/{id}
Organization
- Read
Get an organization
Retrieve an organization by slug or ID
GET /organization/{org-slug-or-id} - Read
List the entries in the org's URL Orb allow-list
List the entries in the org's URL Orb allow-list
GET /organization/{org-slug-or-id}/url-orb-allow-list - Write
Create a new organization
Create a new organization. For VCS providers (GitHub/Bitbucket), this validates access and syncs org data. For standalone orgs, this creates a new CircleCI organization.
POST /organization - Write
Create a new URL Orb allow-list entry
Create a new URL Orb allow-list entry
POST /organization/{org-slug-or-id}/url-orb-allow-list - Destructive
Delete an organization
Delete an organization. This action will delete all projects including all build data for the organization.
DELETE /organization/{org-slug-or-id} - Destructive
Remove an entry from the org's URL orb allow-list
Remove an entry from the org's URL orb allow-list
DELETE /organization/{org-slug-or-id}/url-orb-allow-list/{allow-list-entry-id}
Project
- Read
Get a project
Retrieves a project by project slug.
GET /project/{project-slug} - Read
Get all checkout keys
Returns a sequence of checkout keys for `:project`.
GET /project/{project-slug}/checkout-key - Read
Get a checkout key
Returns an individual checkout key via md5 or sha256 fingerprint. sha256 keys should be url-encoded.
GET /project/{project-slug}/checkout-key/{fingerprint} - Read
List all environment variables
Returns four 'x' characters, in addition to the last four ASCII characters of the value, consistent with the display of environment variable values on the CircleCI website.
GET /project/{project-slug}/envvar - Read
Get a masked environment variable
Returns the masked value of environment variable :name.
GET /project/{project-slug}/envvar/{name} - Read
Get project settings
Returns a list of the advanced settings for a CircleCI project, whether enabled (true) or not (false).
GET /project/{provider}/{organization}/{project}/settings - Write
Create a new project
Create a new project. Works for all organization types.
POST /organization/{org-slug-or-id}/project - Write
Create a new checkout key
Not available to projects that use GitLab or GitHub App. Creates a new checkout key. This API request is only usable with a user API token. Please ensure that you have authorized your account with GitHub before creating user keys. This is necessary to give CircleCI the permission to create a user key associated with your GitHub user account. You can find this page by visiting Project Settings > Checkout SSH Keys
POST /project/{project-slug}/checkout-key - Write
Create an environment variable
Creates a new environment variable.
POST /project/{project-slug}/envvar - Destructive
Delete a project
Deletes a project by project slug
DELETE /project/{project-slug} - Destructive
Delete a checkout key
Deletes the checkout key via md5 or sha256 fingerprint. sha256 keys should be url-encoded.
DELETE /project/{project-slug}/checkout-key/{fingerprint} - Destructive
Delete an environment variable
Deletes the environment variable named :name.
DELETE /project/{project-slug}/envvar/{name} - Destructive
Update project settings
Updates one or more of the advanced settings for a CircleCI project.
PATCH /project/{provider}/{organization}/{project}/settings
Pipeline
- Read
Get a list of pipelines
Returns all pipelines for the most recently built projects (max 250) you follow in an organization.
GET /pipeline - Read
Get a pipeline by ID
Returns a pipeline by the pipeline ID.
GET /pipeline/{pipeline-id} - Read
Get a pipeline's configuration
Returns a pipeline's configuration by ID.
GET /pipeline/{pipeline-id}/config - Read
Get a pipeline's workflows
Returns a paginated list of workflows by pipeline ID.
GET /pipeline/{pipeline-id}/workflow - Read
Get all pipelines
Returns all pipelines for this project.
GET /project/{project-slug}/pipeline - Read
Get your pipelines
Returns a sequence of all pipelines for this project triggered by the user.
GET /project/{project-slug}/pipeline/mine - Read
Get a pipeline by pipeline number
Returns a pipeline by the pipeline number.
GET /project/{project-slug}/pipeline/{pipeline-number} - Read
Get pipeline values for a pipeline
Returns a map of pipeline values by pipeline ID. For more information see the [pipeline values reference page](https://circleci.com/docs/variables/#pipeline-values).
GET /pipeline/{pipeline_id}/values - Write
Continue a pipeline
Continue a pipeline from the setup phase. For information on using pipeline parameters with dynamic configuration, see the [Pipeline values and parameters](https://circleci.com/docs/pipeline-variables/#pipeline-parameters-and-dynamic-configuration) docs.
POST /pipeline/continue - Write
Trigger a new pipeline
**[This endpoint is superseded by the [new Trigger Pipeline API](#tag/Pipeline/operation/triggerPipelineRun), which supports all organization and pipeline types except GitLab.]** Triggers a new pipeline on the project. Does not support triggering pipelines integrated with GitLab or GitHub App.
POST /project/{project-slug}/pipeline - Write
[Recommended] Trigger a new pipeline
Trigger a pipeline given a pipeline definition ID. Currently only supported for pipeline definitions where `config_source.provider` is `github_app`, `github_server`, `github_oauth`, `bitbucket_dc`, or `bitbucket_oauth`. The slash-separated project slug is shown in Project Settings > Overview. Depending on the organization type, the project slug may have a human-readable format (`vcs_type/org_name/project_name`) or be an opaque string (e.g. `circleci/43G3lM5RtfFE7v5sa4nWAU/44n9wujWcTnVZ2b5S8Fnat`).
POST /project/{provider}/{organization}/{project}/pipeline/run
Schedule
- Read
List schedule triggers
For a given project, returns all schedules associated with GitHub OAuth or Bitbucket Cloud pipeline definitions. Does not return schedule triggers associated with GitHub App pipelines. To fetch schedule triggers associated with GitHub App pipelines, use the [List pipeline definition triggers](https://circleci.com/docs/api/v2/index.html#tag/Trigger/operation/listPipelineDefinitionTriggers] endpoint.
GET /project/{project-slug}/schedule - Read
Get a schedule by ID. Available only on schedules associated with GitHub OAuth or Bitbucket Cloud pipeline definitions.
Get a schedule by id.
GET /schedule/{schedule-id} - Write
Create a schedule
Creates a schedule and returns the created schedule. Available only on organizations of type `bitbucket` and `github`, and for the latter will exclusively create schedule triggers associated with the GitHub OAuth pipeline definition. For projects of type `circleci`, or to create schedule triggers for GitHub App pipeline definitions, use the [Create trigger](https://circleci.com/docs/api/v2/index.html#tag/Trigger/operation/createTrigger) endpoint.
POST /project/{project-slug}/schedule - Write
Update a schedule
Updates a schedule and returns the updated schedule. Available only on schedules associated with GitHub OAuth or Bitbucket Cloud pipeline definitions. To update schedule triggers for GitHub App pipeline definitions, use the [Update trigger](https://circleci.com/docs/api/v2/index.html#tag/Trigger/operation/updateTrigger) endpoint.
PATCH /schedule/{schedule-id} - Destructive
Delete a schedule
Deletes a schedule by ID. Available only on schedules associated with GitHub OAuth or Bitbucket Cloud pipeline definitions.
DELETE /schedule/{schedule-id}
Workflow
- Read
Get a workflow's jobs
Returns a sequence of jobs for a workflow.
GET /workflow/{id}/job - Read
Get a workflow
Returns summary fields of a workflow by ID.
GET /workflow/{id} - Write
Approve a job
Approves a pending approval job in a workflow.
POST /workflow/{id}/approve/{approval_request_id} - Write
Rerun a workflow
Reruns a workflow.
POST /workflow/{id}/rerun - Destructive
Cancel a workflow
Cancels a running workflow.
POST /workflow/{id}/cancel
OIDC Token Management
- Read
Get org-level claims
Fetches org-level custom claims of OIDC identity tokens
GET /org/{orgID}/oidc-custom-claims - Read
Get project-level claims
Fetches project-level custom claims of OIDC identity tokens
GET /org/{orgID}/project/{projectID}/oidc-custom-claims - Write
Patch org-level claims
Creates/Updates org-level custom claims of OIDC identity tokens
PATCH /org/{orgID}/oidc-custom-claims - Write
Patch project-level claims
Creates/Updates project-level custom claims of OIDC identity tokens
PATCH /org/{orgID}/project/{projectID}/oidc-custom-claims - Destructive
Delete org-level claims
Deletes org-level custom claims of OIDC identity tokens
DELETE /org/{orgID}/oidc-custom-claims - Destructive
Delete project-level claims
Deletes project-level custom claims of OIDC identity tokens
DELETE /org/{orgID}/project/{projectID}/oidc-custom-claims
Policy Management
- Read
Retrieves the owner's decision audit logs.
This endpoint will return a list of decision audit logs that were made using this owner's policies.
GET /owner/{ownerID}/context/{context}/decision - Read
Get the decision settings
This endpoint retrieves the current decision settings (eg enable/disable policy evaluation)
GET /owner/{ownerID}/context/{context}/decision/settings - Read
Retrieves the owner's decision audit log by given decisionID
This endpoint will retrieve a decision for a given decision log ID
GET /owner/{ownerID}/context/{context}/decision/{decisionID} - Read
Retrieves Policy Bundle for a given decision log ID
This endpoint will retrieve a policy bundle for a given decision log ID
GET /owner/{ownerID}/context/{context}/decision/{decisionID}/policy-bundle - Read
Retrieves Policy Bundle
This endpoint will retrieve a policy bundle
GET /owner/{ownerID}/context/{context}/policy-bundle - Read
Retrieves a policy document
This endpoint will retrieve a policy document.
GET /owner/{ownerID}/context/{context}/policy-bundle/{policyName} - Write
Makes a decision
This endpoint will evaluate input data (config+metadata) against owner's stored policies and return a decision.
POST /owner/{ownerID}/context/{context}/decision - Destructive
Set the decision settings
This endpoint allows modifying decision settings (eg enable/disable policy evaluation)
PATCH /owner/{ownerID}/context/{context}/decision/settings - Destructive
Creates policy bundle for the context
This endpoint replaces the current policy bundle with the provided policy bundle
POST /owner/{ownerID}/context/{context}/policy-bundle
Context
- Read
List contexts
List all contexts for an owner.
GET /context - Read
Get a context
Returns basic information about a context.
GET /context/{context_id} - Read
List environment variables
List information about environment variables in a context, not including their values.
GET /context/{context_id}/environment-variable - Read
Get context restrictions
Gets a list of project and expression restrictions associated with a context.
GET /context/{context_id}/restrictions - Write
Create a new context
Creates a new context in the specified organization.
POST /context - Write
Create context restriction
Creates project or expression restriction on a context.
POST /context/{context_id}/restrictions - Destructive
Delete a context
Delete a context by its ID. Will also delete all environment variables inside the context.
DELETE /context/{context_id} - Destructive
Add or update an environment variable
Create or update an environment variable within a context. Returns information about the environment variable, not including its value.
PUT /context/{context_id}/environment-variable/{env_var_name} - Destructive
Remove an environment variable
Delete an environment variable from a context.
DELETE /context/{context_id}/environment-variable/{env_var_name} - Destructive
Delete context restriction
Deletes a project, expression or group restriction from a context.
DELETE /context/{context_id}/restrictions/{restriction_id}
Groups
- Read
Groups in an organization
Get all the groups in an organization.
GET /organizations/{org_id}/groups - Read
A group in an organization
Get details for a group in an organization. Currently only supported for standalone organizations.
GET /organizations/{org_id}/groups/{group_id} - Write
Create Groups
Create a new group under the organization. Currently only supported for standalone organizations.
POST /organizations/{org_id}/groups - Destructive
Delete a group
Delete a group in an organization. This will remove all members from the group as well, and the subsequent role grants tied to the group. Currently only supported for standalone organizations.
DELETE /organizations/{org_id}/groups/{group_id}
Usage
- Read
Get a usage export
Gets a usage export for an organization.
GET /organizations/{org_id}/usage_export_job/{usage_export_job_id} - Write
Create a usage export
Submits a request to create a usage export for an organization.
POST /organizations/{org_id}/usage_export_job
Pipeline Definition
- Read
List pipeline definitions
List all pipeline definitions for a given project. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs.
GET /projects/{project_id}/pipeline-definitions - Read
Get pipeline definition
Get details for a pipeline definition. Currently only supported for pipeline definitions where `config_source.provider` is `github_app`, `github_server`, `github_oauth`, `bitbucket_dc`, `bitbucket_oauth` or `gitlab`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs.
GET /projects/{project_id}/pipeline-definitions/{pipeline_definition_id} - Write
Create pipeline definition
Create a pipeline definition for a given project. Currently only supported for pipeline definitions where `config_source.provider` is `github_app` or `github_server`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs.
POST /projects/{project_id}/pipeline-definitions - Write
Update pipeline definition
Update pipeline definition. Currently only supported for pipeline definitions where `config_source.provider` is `github_app`, `github_server`, or `bitbucket_dc`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs.
PATCH /projects/{project_id}/pipeline-definitions/{pipeline_definition_id} - Destructive
Delete pipeline definition
Delete pipeline definition. Currently only supported for pipeline definitions where `config_source.provider` is `github_app`, `github_server`, or `bitbucket_dc`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs.
DELETE /projects/{project_id}/pipeline-definitions/{pipeline_definition_id}
Trigger
- Read
List pipeline definition triggers
List all triggers for a given pipeline definition. Currently only supported for pipeline definitions where `config_source.provider` is `github_oauth`, `github_app`, `github_server`, `bitbucket_dc`, or `schedule`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs.
GET /projects/{project_id}/pipeline-definitions/{pipeline_definition_id}/triggers - Read
Get trigger
Get details for a trigger. Currently only supported for triggers where `event_source.provider` is `github_oauth`, `github_app`, `github_server`, `bitbucket_dc`, `webhook`, or `schedule`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs.
GET /projects/{project_id}/triggers/{trigger_id} - Write
Create trigger
Create a trigger for a given pipeline definition. Currently only supported for pipeline definitions where `config_source.provider` is `github_oauth`, `github_app`, `github_server`, or `schedule`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs.
POST /projects/{project_id}/pipeline-definitions/{pipeline_definition_id}/triggers - Destructive
Update trigger
Update a trigger. Currently only supported for triggers where `event_source.provider` is `github_oauth`, `github_app`, `github_server`, `bitbucket_dc`, `webhook`, or `schedule`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs.
PATCH /projects/{project_id}/triggers/{trigger_id} - Destructive
Delete trigger
Delete a trigger. Currently only supported for triggers where `event_source.provider` is `github_oauth`, `github_app`, `github_server`, `bitbucket_dc`, `webhook`, or `schedule`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs.
DELETE /projects/{project_id}/triggers/{trigger_id}
Rollback
- Write
Rollback a project
Performs a rollback operation by triggering a rollback pipeline.
POST /projects/{project_id}/rollback
Deploy
- Read
List Environments
Allows listing environments for a given organization ID.
GET /deploy/environments - Read
Get Environment
Allows getting an environment for a given environment ID.
GET /deploy/environments/{environment_id} - Read
List Components
Allows for listing of components for a given organization ID.
GET /deploy/components - Read
Get Component
Get the details of a component by ID.
GET /deploy/components/{component_id} - Read
List Component Versions
List the versions for a component.
GET /deploy/components/{component_id}/versions
Webhook
- Read
List webhooks
Get a list of outbound webhooks that match the given scope-type and scope-id.
GET /webhook - Read
Get a webhook
Get an outbound webhook by id.
GET /webhook/{webhook_id} - Write
Create an outbound webhook
Creates an outbound webhook for the given scope.
POST /webhook - Destructive
Update an outbound webhook
Updates an existing outbound webhook by its unique ID.
PUT /webhook/{webhook_id} - Destructive
Delete an outbound webhook
Deletes an existing outbound webhook by its unique ID.
DELETE /webhook/{webhook_id}
OTel
- Read
🧪 List OTLP exporters
[__EXPERIMENTAL__] Returns a list of OTLP exporter configurations for the given organization.
GET /otel/exporters - Write
🧪 Create an OTLP exporter
[__EXPERIMENTAL__] Creates a new OTLP exporter configuration for the given organization. A maximum of 5 exporter configurations are allowed per organization.
POST /otel/exporters - Destructive
🧪 Delete an OTLP exporter
[__EXPERIMENTAL__] Deletes an OTLP exporter configuration by ID.
DELETE /otel/exporters/{otel_exporter_id}
No operations match.
See How connections work for access and permissions, or browse all integrations.