Skip to main content
POST
Query Pull Requests

Authorizations

Authorization
string
header
required

The API key to authenticate requests. Obtainable from the web dashboard.

Body

application/json
query
string
required

Natural-language description of the pull requests to retrieve. Criteria such as status, labels, or time range are expressed in the query text, including references to people and their role (for example, authored by or reviewed by). Repository scoping is provided separately via the projects field.

Minimum string length: 1
projects
string[]

Repository or project names that scope the query (for example, GitHub repository names). Each value is resolved against all connected providers and applied as a filter. When omitted or empty, all accessible repositories are searched.

userName
string

Name, display name, or username of a person referenced by the query. The value is resolved to a known identity before the query runs; the literal value me resolves to the user associated with the API key.

Response

OK

sources
object[]
required

The issues or pull requests matching the query criteria.