<!--
{
  "documentType" : "article",
  "framework" : "AppStoreConnectAPI",
  "identifier" : "/documentation/AppStoreConnectAPI/workflows",
  "metadataVersion" : "0.1.0",
  "role" : "collectionGroup",
  "title" : "Workflows"
}
-->

# Workflows

Manage Xcode Cloud workflows and view workflow details like actions and start conditions.

## Discussion

The `ciWorkflows` resource represents an Xcode Cloud workflow. Use it to:

- Read workflow information.
- Create a new workflow.
- Update an existing workflow.
- Delete a workflow you no longer need.

To learn more about workflows, see <doc://com.apple.documentation/documentation/Xcode/Xcode-Cloud-Workflow-Reference>.

> Important:
> Deleting a workflow also deletes associated build information and artifacts. Instead of deleting a workflow, consider deactivating it in Xcode or App Store Connect. To learn more about deactivating a workflow, see <doc://com.apple.documentation/documentation/Xcode/Developing-a-Workflow-Strategy-for-Xcode-Cloud>.

This resource supports JSON web tokens with a lifetime of up to six months. For more information, see [Determine the Appropriate Token Lifetime](/documentation/AppStoreConnectAPI/generating-tokens-for-api-requests#Determine-the-Appropriate-Token-Lifetime).

## Topics

### Getting Xcode Cloud Workflows

[`Read xcode cloud workflow information`](/documentation/AppStoreConnectAPI/GET-v1-ciWorkflows-_id_)

Get information about a specific Xcode Cloud workflow.

[`List all xcode cloud builds for a workflow`](/documentation/AppStoreConnectAPI/GET-v1-ciWorkflows-_id_-buildRuns)

List all builds Xcode Cloud performed for a specific workflow.

[`Read the repository information for an xcode cloud workflow`](/documentation/AppStoreConnectAPI/GET-v1-ciWorkflows-_id_-repository)

Get information about the Git repository of a specific Xcode Cloud workflow.

[`List build run IDs for a CI workflow`](/documentation/AppStoreConnectAPI/GET-v1-ciWorkflows-_id_-relationships-buildRuns)

[`Get the repository ID for a CI workflow`](/documentation/AppStoreConnectAPI/GET-v1-ciWorkflows-_id_-relationships-repository)

### Managing Xcode Cloud Workflows

[`Create a workflow`](/documentation/AppStoreConnectAPI/POST-v1-ciWorkflows)

Create a new Xcode Cloud workflow for an Xcode Cloud product.

[`Update an xcode cloud workflow`](/documentation/AppStoreConnectAPI/PATCH-v1-ciWorkflows-_id_)

Make changes to an Xcode Cloud workflow.

[`Delete a workflow`](/documentation/AppStoreConnectAPI/DELETE-v1-ciWorkflows-_id_)

Delete an Xcode Cloud workflow and all of its associated data.

### Objects and types

[`object CiWorkflow`](/documentation/AppStoreConnectAPI/CiWorkflow)

An Xcode Cloud automation configuration specifying when to build, which actions to run, and how to distribute the output.

[`object CiAction`](/documentation/AppStoreConnectAPI/CiAction)

A step within an Xcode Cloud workflow, such as building, running tests, analyzing, or deploying an app.

[`object CiWorkflowCreateRequest`](/documentation/AppStoreConnectAPI/CiWorkflowCreateRequest)

The request body you use to create a new Xcode Cloud workflow.

[`object CiWorkflowUpdateRequest`](/documentation/AppStoreConnectAPI/CiWorkflowUpdateRequest)

The request body you use to update an Xcode Cloud workflow.

[`object CiWorkflowResponse`](/documentation/AppStoreConnectAPI/CiWorkflowResponse)

The response body for endpoints that create, read, or modify an Xcode Cloud workflow.

[`object CiWorkflowsResponse`](/documentation/AppStoreConnectAPI/CiWorkflowsResponse)

The response body for endpoints that list Xcode Cloud workflows for a product.

[`object CiBuildRunsResponse`](/documentation/AppStoreConnectAPI/CiBuildRunsResponse)

The response body for endpoints that list build runs for an Xcode Cloud workflow.

[`object CiManualBranchStartCondition`](/documentation/AppStoreConnectAPI/CiManualBranchStartCondition)

A workflow start condition that triggers an Xcode Cloud build when a specified branch is manually selected.

[`object CiManualPullRequestStartCondition`](/documentation/AppStoreConnectAPI/CiManualPullRequestStartCondition)

A workflow start condition that triggers an Xcode Cloud build for a manually specified pull request.

[`object CiManualTagStartCondition`](/documentation/AppStoreConnectAPI/CiManualTagStartCondition)

A workflow start condition that triggers an Xcode Cloud build when a specified tag is manually selected.

[`object CiWorkflowBuildRunsLinkagesResponse`](/documentation/AppStoreConnectAPI/CiWorkflowBuildRunsLinkagesResponse)

[`object CiWorkflowRepositoryLinkageResponse`](/documentation/AppStoreConnectAPI/CiWorkflowRepositoryLinkageResponse)



---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)