Read Pull Request Information
Get information about a specific pull request.
URL
GET https://api.appstoreconnect.apple.com/v1/scmPullRequests/{id}Path Parameters
| Name | Type | Description |
|---|---|---|
id Required | string | The opaque resource ID that uniquely identifies the Pull Requests resource. |
Query Parameters
| Name | Type | Description |
|---|---|---|
fields[scmPullRequests] Optional | [string] | Additional fields to include for the Pull Requests resource returned by the response. |
include Optional | [string] | The relationship data to include in the response. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | ScmPullRequestResponse | 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 pull request. For example, use the data provided in the response to display pull request information on a custom dashboard.