Get draft pull request status
curl --request GET \
--url https://sparkles.dev/api/public/v1/sandboxes/{sandboxId}/pull-request \
--header 'Authorization: Bearer <token>'import requests
url = "https://sparkles.dev/api/public/v1/sandboxes/{sandboxId}/pull-request"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sparkles.dev/api/public/v1/sandboxes/{sandboxId}/pull-request', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sparkles.dev/api/public/v1/sandboxes/{sandboxId}/pull-request",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sparkles.dev/api/public/v1/sandboxes/{sandboxId}/pull-request"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sparkles.dev/api/public/v1/sandboxes/{sandboxId}/pull-request")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sparkles.dev/api/public/v1/sandboxes/{sandboxId}/pull-request")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"actionState": "idle",
"checks": {
"label": "<string>",
"runs": [
{
"id": 123,
"name": "<string>",
"conclusion": "<string>",
"createdAt": "<string>",
"event": "<string>",
"headBranch": "<string>",
"headSha": "<string>",
"runNumber": 0,
"status": "<string>",
"updatedAt": "<string>",
"url": "<string>"
}
],
"checkRuns": [
{
"id": 123,
"name": "<string>",
"completedAt": "<string>",
"conclusion": "<string>",
"startedAt": "<string>",
"status": "<string>",
"url": "<string>"
}
],
"state": "idle",
"error": "<string>",
"updatedAt": "<string>"
},
"comments": [
{
"id": 123,
"title": "<string>",
"author": "<string>",
"authorAvatarUrl": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"url": "<string>"
}
],
"pullRequest": {
"id": 123,
"nodeId": "<string>",
"number": 123,
"url": "<string>",
"title": "<string>",
"state": "open",
"draft": true,
"merged": true,
"baseRef": "<string>",
"headRef": "<string>",
"headSha": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"additions": 4503599627370495,
"deletions": 4503599627370495,
"changedFiles": 4503599627370495
},
"repository": "<string>",
"detailsPending": true
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Get draft pull request status
GET
/
api
/
public
/
v1
/
sandboxes
/
{sandboxId}
/
pull-request
Get draft pull request status
curl --request GET \
--url https://sparkles.dev/api/public/v1/sandboxes/{sandboxId}/pull-request \
--header 'Authorization: Bearer <token>'import requests
url = "https://sparkles.dev/api/public/v1/sandboxes/{sandboxId}/pull-request"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sparkles.dev/api/public/v1/sandboxes/{sandboxId}/pull-request', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sparkles.dev/api/public/v1/sandboxes/{sandboxId}/pull-request",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sparkles.dev/api/public/v1/sandboxes/{sandboxId}/pull-request"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sparkles.dev/api/public/v1/sandboxes/{sandboxId}/pull-request")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sparkles.dev/api/public/v1/sandboxes/{sandboxId}/pull-request")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"actionState": "idle",
"checks": {
"label": "<string>",
"runs": [
{
"id": 123,
"name": "<string>",
"conclusion": "<string>",
"createdAt": "<string>",
"event": "<string>",
"headBranch": "<string>",
"headSha": "<string>",
"runNumber": 0,
"status": "<string>",
"updatedAt": "<string>",
"url": "<string>"
}
],
"checkRuns": [
{
"id": 123,
"name": "<string>",
"completedAt": "<string>",
"conclusion": "<string>",
"startedAt": "<string>",
"status": "<string>",
"url": "<string>"
}
],
"state": "idle",
"error": "<string>",
"updatedAt": "<string>"
},
"comments": [
{
"id": 123,
"title": "<string>",
"author": "<string>",
"authorAvatarUrl": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"url": "<string>"
}
],
"pullRequest": {
"id": 123,
"nodeId": "<string>",
"number": 123,
"url": "<string>",
"title": "<string>",
"state": "open",
"draft": true,
"merged": true,
"baseRef": "<string>",
"headRef": "<string>",
"headSha": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"additions": 4503599627370495,
"deletions": 4503599627370495,
"changedFiles": 4503599627370495
},
"repository": "<string>",
"detailsPending": true
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Long-lived opaque API key minted by an approved user at /api. The secret is shown once, stored only as a SHA-256 digest, and disabled immediately when either the key or its API access grant is revoked.
Path Parameters
Pattern:
^c_[a-z2-9]{12}$Query Parameters
Maximum string length:
201Pattern:
^[A-Za-z0-9._-]+\/[A-Za-z0-9._-]+$Response
Current draft pull request and check status