Skip to main content
GET
/
v2
/
studio
/
deployment
List deployments
curl --request GET \
  --url https://api.neynar.com/v2/studio/deployment/ \
  --header 'x-api-key: <api-key>'
[
  {
    "deleted_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "namespace": "<string>",
    "name": "<string>",
    "is_ready": true,
    "generated_app_exists": true,
    "generated_app_serving": true,
    "display_name": "<string>",
    "url": "<string>",
    "github_url": "<string>",
    "production_app_status": {
      "project_id": "<string>",
      "deployment_url": "<string>",
      "deployment_state": "<string>",
      "created_at": 123,
      "target": "<string>"
    }
  }
]
The Miniapp Studio API is an allowlisted API and not publicly available. Contact the Neynar team for more information.

Authorizations

​
x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Query Parameters

​
fid
integer<int32> | null

Farcaster ID of the user. Required for non-admin users. Studio admins can omit to query all deployments.

Required range: x >= 0
Example:

3

​
limit
integer
default:50

Maximum number of deployments to return. Defaults to 50, max 1000.

Required range: 1 <= x <= 1000
​
offset
integer | null
default:0

Number of deployments to skip for pagination. Defaults to 0.

Required range: x >= 0
​
include_deleted
boolean | null
default:false

Include deleted deployments in the response. Defaults to false.

Response

Success

​
deleted_at
string<date-time> | null
required

Deletion timestamp

​
updated_at
string<date-time> | null
required

Last update timestamp

​
created_at
string<date-time>
required

Creation timestamp

​
namespace
string
required

Kubernetes namespace

​
name
string
required

Kubernetes deployment name

​
is_ready
boolean
required

Deployment is ready to serve app and accept prompts

​
generated_app_exists
boolean
required

Whether a generated app exists in the deployment

​
generated_app_serving
boolean
required

Whether the generated app is currently serving

​
display_name
string

Display name for the project

​
url
string<uri>

Public URL for the deployment

​
github_url
string

GitHub repository SSH URL

​
production_app_status
object

Production app deployment status from Vercel