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>'
[
  {
    "id": "<string>",
    "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>"
    }
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.neynar.com/llms.txt

Use this file to discover all available pages before exploring further.

The Miniapp Studio API is an allowlisted API and not publicly available. Contact the Neynar team for more information.

ā€‹
Node.js SDK

šŸ”— SDK Method: listDeployments Use this API endpoint with the Neynar Node.js SDK for typed responses and better developer experience.

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
ā€‹
query
string

Search string to filter deployments by name, display name, or FID.

ā€‹
sort_by
enum<string>
default:updated_at

Field to sort deployments by. Defaults to updated_at (most recently updated first).

Available options:
created_at,
updated_at
ā€‹
include_deleted
boolean | null
default:false

Include deleted deployments in the response. Defaults to false.

Response

Success

ā€‹
id
string
required

Deployment ID

ā€‹
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