View as Markdown
Rydoo icon

Rydoo ACTION

Find Group

Searches for organizational groups by name to find their UUIDs. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Rydoo account once, then configure and run Find Group 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: "rydoo-find-group",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    rydoo: { authProvisionId: "apn_xxxxxxx" },
    search: "Search",
    isActive: true,
  },
})

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.

Find Group inputs
Property Type Description
search Search string
Filter groups where the name contains this string
Optional
isActive Is Active boolean
Filter by active status (true for active groups only, false for inactive)
Optional
parentGroupId Parent Group string
Retrieve groups with the specified parent group. If not set, returns only root-level groups (e.g., d290f1ee-6c54-4b01-90e6-d701748f0851)
Optional Dynamic
branchId Branch string
The unique identifier of a branch (e.g., d290f1ee-6c54-4b01-90e6-d701748f0851)
Optional Dynamic
branchIds Branches string[]
The unique identifiers of one or more branches (e.g., d290f1ee-6c54-4b01-90e6-d701748f0851)
Optional Dynamic
loadAllLevels Load All Levels boolean
When set to true, returns all nested group levels instead of only the top level
Optional
sort Sort string
The field to sort the results by (e.g., name)
Optional
limit Limit integer
The number of groups to return per page (defaults to 50)
Optional
offset Offset integer
The number of groups to skip for paging (defaults to 0)
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
rydoo-find-group
Version
0.0.2
App
Rydoo
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes