Actions19
- Account Actions
- Installation Actions
- Partner Actions
- User Actions
Partner → Get Many
AI-generatedSummary
Retrieve a list of partners under the authenticated partner context, optionally fetching child partners recursively, and specify which partner fields to include in the response.
Inputs
- Fetch Recursively — Boolean flag to fetch all sub-partners recursively. Defaults to true.
- Fields — List of partner fields to include in the response such as Name, Level, Service Type, State, Location ID, etc. Defaults to Name, Level, Child Service Types, Service Type, State, and Location ID.
- Return All — Boolean flag to return all partners or limit the number of results. Defaults to true.
- Limit — Maximum number of results to return if 'Return All' is false. Defaults to 50.
Output shape
a list of partner objects
The operation returns an array of partners as JSON objects. The response may be paginated based on the 'Return All' and 'Limit' parameters. Each partner object contains the fields requested via the 'Fields' input.
Examples
Example 1: Get all partners with default fields recursively
Fetch Recursively=true, Return All=true, Fields=default set
Example 2: Get up to 10 partners non-recursively with selected fields
Fetch Recursively=false, Return All=false, Limit=10, Fields=Name and State