API References

The API consists of the following objects from which you can extract data

Articles

Users API
A user object creates and acts on other objects.  When multiple user records are associated with an individual, due to differences in email or variations in a name for example, user records can be merged under a single apex user record. Suppo...
User alias API
A user alias object is created for each unique way a user shows up in a source system such as GitHub, and Jira. One person may do work under many different email addresses or user ids. The user alias object is a record of each of those identities. M...
Commits API
A commit represents a set of code changes stored in git. Supported request Get a list of commits: https://flow.pluralsight.com/v3/customer/core/commits/ Fields Name Type Description id double Commit ID (not the SHA). hexsha ...
Events API
An Even t represents a labeled date of note that is defined by a user and appears in various reports to offer context. Events can be given tags, which allow them to be organized into logical groups. Supported request Get a list of events: h...
Integrations API
An Integration is a representation of a connection between a user and a vendor like Github, Bitbucket, etc. Supported request Get a list of integrations: https://flow.pluralsight.com/v3/customer/core/integrations/ Fields Name Type Descr...
Pull request comments API
A pull request comment is a comment made by a user related to a specific pull request. Supported requests Get a list of pull request comments: https://flow.pluralsight.com/v3/customer/core/pull_request_comments/ Fields Name Type Descrip...
Pull request events API
A pull request event is an event about a pull request such as a comment or an approval.  It is supplied to Flow by the vendor. Supported request Get a list of pull request events: https://flow.pluralsight.com/v3/customer/core/pull_request_e...
Request URL in the Flow API
The request URL is a string representing the URL of the request. The URL syntax looks like: [protocol]://[hostname][api version][customer/core][object][parameter(s)] Where: Protocol is the network protocol used to make the request. ...
Pull request projects API
A pull request project represents an entity that is the recipient of pull requests. All pull requests are tied to a pull request project. Typically, all pull request projects are also bound to a repository, which are discovered using a user's cr...
Pull requests API
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. Supported request Get a list of pu...
Filtering requests API
The Flow API is built using the Django Rest Framework and supports basic and enhanced filtering options. Most operators are supported. Learn more about Django REST framework . In this article Basic filter options Enhanced filter opti...
Repos API
A repository is a representation of a source control repository that has been discovered by Flow using a set of user credentials. Once a repository is discovered, it is then tied to a pull request project. Supported request Get a list of repositor...
Targets API
A target represents a user-defined goal for an individual or team. Goals are reflected in specific reports. Supported request Get a list of targets: https://flow.pluralsight.com/v3/customer/core/targets/ Fields Name Type Description ...
Traversing objects in the Flow API
Requesting data from two related objects is usually not easy in rest requests. Normally, you have to make separate API calls to get the exact data you want. Flow makes traversing multiple, related objects a snap.   For example. to request a ...
Team membership API
Team membership is what defines a relationship between users and teams, as well as the nature of their relationship. Supported request Get a list of team memberships. https://flow.pluralsight.com/v3/customer/core/team_membership/ Fields N...
Teams API
Overview A team represents a user-defined group of authors. Supported request Get a list of teams: https://flow.pluralsight.com/v3/customer/core/teams/ Fields Name Type Description id double Unique identifier for a team. name...
Ticket comments API
A ticket comment is a comment made by a user related to a specific ticket. Supported request Get a list of ticket comments: https://flow.pluralsight.com/v3/customer/core/ticket_comments/ Fields Name Type Description id double Uni...
Ticket events API
A ticket event represents a state change within an issue-tracking system lifecycle. Supported request Get a list of ticket events: https://flow.pluralsight.com/v3/customer/core/ticket_events/ Fields Name Type Description id double...
Ticket projects API
A ticket project represents a project within an issue-tracking software that contains tickets. All tickets are tied to a ticket project, which is discovered using a set of credentials. Supported request Get a list of ticket projects: https:...
Tickets API
A ticket is a specific issue filed by a user within an integrated issue-tracking software application. Supported request Get a list of tickets: https://flow.pluralsights.com/v3/customer/core/tickets/ Fields Name Type Description ...
Code fundamentals API
The Code fundamentals API provides the metrics in the Code fundamentals report for use outside of Flow.  Note:  This endpoint is not documented in Flow's interactive API documentation .   The API gives you averages for...