Zoho BiginInstall

Summary

Retrieve multiple company records from Zoho Bigin, optionally filtering by specific fields and sorting the results.

Inputs

• returnAll — When true, fetches up to 200 records per page (Zoho API limit). When false, use 'limit' to specify the maximum number of records to return.
• limit — Maximum number of records to return (1–200). Only used when 'returnAll' is false.
• options.fields — Comma-separated list of fields to include in the response. Empty string returns all available fields.
• options.sort_by — Field name to sort by (default: 'id').
• options.sort_order — Sort order: 'asc' for ascending or 'desc' for descending (default: 'desc').

Output shape

a list of items, where each item represents a company record

The API response is wrapped in a 'data' array. Pagination is handled automatically via the 'per_page' query parameter (max 200).

Examples

Example 1: Fetch the most recent 50 companies, sorted by ID in descending order

returnAll: false, limit: 50, options.sort_by: id, options.sort_order: desc

Example 2: Retrieve all available company records

returnAll: true

Example 3: Get a specific subset of company fields, sorted by Company Name

returnAll: false, limit: 20, options.fields: Company_Name,Email,Phone, options.sort_by: Company_Name, options.sort_order: asc