View as Markdown
Arlo icon

Arlo ACTION

List Venues

List Arlo venue records. Use the returned VenueID values when specifying VenueDetails in Create Event sessions. Optionally filter by status. Results are paged (see limit/skip); if the page comes back full, call again with a higher skip for more. Use fields to shrink the response for large venue lists. Example: call with status: "Active" to get up to 100 active venues with VenueID, Name, Status. See the documentation.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Arlo account once, then configure and run List Venues 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: "arlo-list-venues",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    arlo: { authProvisionId: "apn_xxxxxxx" },
    status: "Status",
    limit: 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 Venues inputs
Property Type Description
status Status string
Optional. Filter venues by status.
Optional
limit Limit integer
Maximum number of records to return per page. Min 1, max 1000. Defaults to 100. If the response returns exactly this many records, more may exist — call again with a higher skip to page through.
Optional
skip Skip integer
Number of records to skip, for paging past the first page. Defaults to 0 (start at the beginning). Set to limit from the previous call to fetch the next page, 2 * limit for the page after that, and so on.
Optional
fields Fields string[]
Optional. Return only these top-level fields per venue (e.g. ["VenueID", "Name", "Status"]) instead of the full record, to reduce response size for large venue lists.
Optional

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
arlo-list-venues
Version
0.0.2
App
Arlo
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes