List All Xcode Cloud Products

Get a list of all products you created in Xcode Cloud.

URL

GET https://api.appstoreconnect.apple.com/v1/ciProducts

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.
`filter[app]` Optional	[string]	Filter the returned products using the ID of the related Apps resource.
`filter[productType]` Optional	[string]	Filter the returned products using the product type attribute.
`include` Optional	[string]	The relationship data to include in the response.
`limit` Optional	integer	The number of Products resources to return.
`limit[primaryRepositories]` Optional	integer	The number of included Products resources to return if the primary repositories relationship is included.
`fields[apps]` Optional	[string]	Additional fields to include for each Products resource returned by the response.

Response Codes

Status	Reason	Type	Description
200	OK Content-Type: application/json	`CiProductsResponse`	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.
429	Content-Type: application/json	`ErrorResponse`

Discussion

The example request below lists ten Xcode Cloud products and sorts the list using the latestBuildCreatedDate attribute. Use the information provided in the response to display data about your Xcode Cloud products on a dashboard or to read additional information; for example, workflow information.

List All Xcode Cloud Products

URL

Query Parameters

Response Codes

Discussion

Example Request and Response

See Also

Getting Xcode Cloud Products