List deployments
cURL
curl --request GET \
--url 'https://api.neynar.com/v2/studio/deployment/?limit=50&sort_by=updated_at' \
--header 'x-api-key: NEYNAR_API_DOCS'
import requests
url = "https://api.neynar.com/v2/studio/deployment/?limit=50&sort_by=updated_at"
headers = {"x-api-key": "NEYNAR_API_DOCS"}
response = requests.get(url, headers=headers)
print(response.text)
const options = {method: 'GET', headers: {'x-api-key': 'NEYNAR_API_DOCS'}};
fetch('https://api.neynar.com/v2/studio/deployment/?limit=50&sort_by=updated_at', 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://api.neynar.com/v2/studio/deployment/?limit=50&sort_by=updated_at",\
CURLOPT_RETURNTRANSFER => true,\
CURLOPT_ENCODING => "",\
CURLOPT_MAXREDIRS => 10,\
CURLOPT_TIMEOUT => 30,\
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\
CURLOPT_CUSTOMREQUEST => "GET",\
CURLOPT_HTTPHEADER => [\
"x-api-key: NEYNAR_API_DOCS"\
],\
]);
$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://api.neynar.com/v2/studio/deployment/?limit=50&sort_by=updated_at"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "NEYNAR_API_DOCS")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
HttpResponse<String> response = Unirest.get("https://api.neynar.com/v2/studio/deployment/?limit=50&sort_by=updated_at")
.header("x-api-key", "NEYNAR_API_DOCS")
.asString();
require 'uri'
require 'net/http'
url = URI("https://api.neynar.com/v2/studio/deployment/?limit=50&sort_by=updated_at")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = 'NEYNAR_API_DOCS'
response = http.request(request)
puts response.read_body
Responses
Success 200
[
{
"created_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"generated_app_exists": true,
"generated_app_serving": true,
"id": "<string>",
"is_ready": true,
"name": "<string>",
"namespace": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"display_name": "<string>",
"github_url": "<string>",
"has_database": true,
"production_app_status": {
"created_at": 123,
"deployment_state": "<string>",
"deployment_url": "<string>",
"project_id": "<string>",
"target": "<string>"
},
"url": "<string>"
}
]
Error Responses
{
"error": "<string>"
}
Authorizations
x-api-key
- Type: string
- In: header
- Required: true
- Default: NEYNAR_API_DOCS
Query Parameters
- fid (optional): Farcaster ID of the user. Required for non-admin users.
- limit (optional): Default is 50, max 1000.
- offset (optional): Default is 0.
- query (optional): Search string to filter deployments by name, display name, or FID.
- sort_by (optional): Default is updated_at.
- include_deleted (optional): Default is false.