View as Markdown
Starshipit icon

Starshipit ACTION

List Destination Options

Retrieves available options for the Destination field.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Starshipit account once, then configure and run List Destination Options from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "starshipit-list-contact-id-options",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    starshipit: { authProvisionId: "apn_xxxxxxx" },
    page: 10,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Destination Options inputs
Property Type Description
page Page integer
The page of results to retrieve.
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
starshipit-list-contact-id-options
Version
0.0.1
App
Starshipit
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes