Read Xcode Cloud Workflow Information
Get information about a specific Xcode Cloud workflow.
URL
GET https://api.appstoreconnect.apple.com/v1/ciWorkflows/{id}Path Parameters
| Name | Type | Description |
|---|---|---|
id Required | string | The opaque resource ID that uniquely identifies the Workflows resource. |
Query Parameters
| Name | Type | Description |
|---|---|---|
fields[ciWorkflows] Optional | [string] | Additional fields to include for the Workflows resource returned by the response. |
include Optional | [string] | The relationship data to include in the response. |
fields[scmRepositories] Optional | [string] | Additional fields to include for the Workflows resource returned by the response. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | CiWorkflowResponse | The request completed successfully. |
| 400 | Bad Request Content-Type: application/json | ErrorResponse | An error occurred with your request. |
| 401 | Unauthorized Content-Type: application/json | ErrorResponse | |
| 403 | Forbidden Content-Type: application/json | ErrorResponse | Request not authorized. |
| 404 | Not Found Content-Type: application/json | ErrorResponse | Resource not found. |
| 429 | Content-Type: application/json | ErrorResponse |
Discussion
The example request below accesses information about an Xcode Cloud workflow. Display the workflow data provided in the response on a dashboard or use it to read additional information; for example, detailed data about builds Xcode Cloud performed.