v17

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-08165682.0 MB
Deploy requests

List deploy requests

List deploy requests for a database

Authorization

A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:

Service Token Accesses read_deploy_request

OAuth Scopes

ResourceScopes
Organizationread_deploy_requests
Databaseread_deploy_requests
get/organizations/{organization}/databases/{database}/deploy-requests

Path parameters

organizationstring required

The name of the deploy request's organization

databasestring required

The name of the deploy request's database

Query parameters

statestring

Filter by state of the deploy request (open, closed, deployed)

branchstring

Filter by the name of the branch the deploy request is created from

into_branchstring

Filter by the name of the branch the deploy request will be merged into

deployed_atstring

Filter deploy requests by the date they were deployed. (e.g. 2023-01-01T00:00:00Z..2023-01-31T23:59:59Z)

running_atstring

Filter deploy requests by the date they were running. (e.g. 2023-01-01T00:00:00Z..2023-01-31T23:59:59Z)

pageinteger

If provided, specifies the page offset of returned results

per_pageinteger

If provided, specifies the number of returned results

Response

Returns a list of deploy requests

typestring required

The response type. Always "list" for paginated responses.

current_pageinteger required

The current page number

next_pageinteger nullable required

The next page number, or null when this is the last page

next_page_urlstring nullable required

The next page of results, or null when this is the last page

prev_pageinteger nullable required

The previous page number, or null when this is the first page

prev_page_urlstring nullable required

The previous page of results, or null when this is the first page