Neynar Documentation

List deployments

Group: Studio APIs

Use this when you need: List deployments.

Usage

import { NeynarAPIClient, Configuration } from "@neynar/nodejs-sdk";

const client = new NeynarAPIClient(
  new Configuration({ apiKey: "YOUR_NEYNAR_API_KEY" })
);

const res = await client.listDeployments({
  // fid: 123,
  // limit: 123,
  // offset: 123,
  // query: "example",
  // sortBy: "value",
  // includeDeleted: true,
});
console.log(res);

Parameters

Parameter Type Required Description
fid number ❌ -
limit number ❌ -
offset number ❌ -
query string ❌ -
sortBy ListDeploymentsSortByEnum ❌ -
includeDeleted boolean ❌ -

Response

Returns a RequestArgs object.

Error Handling

try {
  const res = await client.listDeployments({ /* required fields */ });
  // use res
} catch (err) {
  // Axios/HTTP errors, invalid params, auth issues, etc.
  console.error(err);
}

Tips