A pull request represents an author's request to have a set of commits merged into a specific repository branch. Once an author submits a pull request, assigners, reviewers, and approvers can alter its state.
Who can use this?
| Core | Plus | ||
| ✓ |
Supported request
Get a list of pull requests:
https://flow.pluralsight.com/v3/customer/core/pull_requests/
Query parameters
Note: Not all query parameters appear in the response. Log into Flow and view the Customer API (opens in new tab) documentation to learn more about specific query parameters and their responses.
| Name | Type | Description |
|---|---|---|
| id | double | Unique identifier for the pull request. |
| title | string | Pull request title. |
| body | string | Pull request body. |
| number | string | Number of commits. |
| state | string | State of a pull request. |
| vendor | string | Source where a pull request originates. |
| url | string | URL of the pull request. |
| project_id | double | Unique identifier for a project. |
| closed_at | string | Date/time a pull request was closed. |
| closed_by_id | double | Unique identifier of PR closer. |
| additions | double | Number of items added to pull request. |
| deletions | double | Number of items deleted from the pull request. |
| commit_shas | string | Unique identifiers associated with a commit. |
| merged_by_id | double | Unique identifier for the person who merged the pull request. |
| extracted_tags | string | An array of extracted tags. |
| merge_commit_sha | string | Unique identifier for the merge commit. |
| created_at | string | Date/time the pull request was created. |
| created_by_id | double | Unique identifier for the person who created the pull request. |
| approvers | string | An array of author_id values for a pull request. |
| assignees | string | An array of author_id values for a pull request. Filter-traversable object. |
| reviewers | string | An array of author_id values for a pull request. Filter-traversable object. |
| user_alias_id | double | Unique identifier assigned to an user alias. PR creator |
| user_alias_id__in | double | Multiple user_alias_ids in comma separated list. |
| apex_user_id | double | Unique identifier for the main user record for multiple user aliases. Creator of PR. |
| apex_user_id__in | double | Multiple apex_user_ids in comma separated list. |
| coding_time | double | Total coding time. |
| review_time | double | Total review time. |
| pr_start | string | Date/time the pull request was opened. |
| pr_end | string | Date/time the pull request was merged/closed. |
| activity_level | string | How active the pull request, indicated by low, medium or high. |
| activity_level_index | double | An index that describes how active the conversation on this PR is. It is based on # of recent comments and size of the PR. |
| time_to_resolve | double | How long it took to resolve a PR in hours. |
| hunk_count | double | Number of files in the pull request. |
| comment_count | double | Number of comments. |
| first_comment_at | string | Date/time first comment was made. |
| total_haloc | double | Total lines of code. |
| total_impact | double | Total impact number. |
| intial_commit_count | double | Number of commits when pull request was opened. |
| reply_commit_count | double | Number of commits made in reply to a comment. |
| reviewer_count | double | Number of reviewers. |
| follow_on_commit_count | double | Number of follow on commits. |
| follow_on_hunk_count | double | Number of follow on files added. |
| reviewer_comment_count | double | Number of reviewer comments. |
Example response
If you need help, please email Support (opens email form) for 24/7 assistance.