Read the Xcode Cloud Product for an App
Get the Xcode Cloud product information for an app you build with Xcode Cloud.
URL
GET https://api.appstoreconnect.apple.com/v1/apps/{id}/ciProductPath Parameters
| Name | Type | Description |
|---|---|---|
id Required | string | The opaque resource ID that uniquely identifies the Apps resource. Obtain the app resource ID from the List Apps response. |
Query Parameters
| Name | Type | Description |
|---|---|---|
fields[ciProducts] Optional | [string] | Additional fields to include for each Products resource returned by the response. |
fields[scmRepositories] Optional | [string] | Additional fields to include for each Products resource returned by the response. |
include Optional | [string] | The relationship data to include in the response. |
limit[primaryRepositories] Optional | integer | The number of included Products resources to return if the primary repositories relationship is included. |
fields[apps] Optional | [string] | |
fields[bundleIds] Optional | [string] |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | CiProductResponse | 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 retrieves information about a specific Xcode Cloud product. Use the data provided in the response to read additional information; for example, workflow information.