Bigin icon

Bigin

Consume Bigin API

Company → Get All

AI-generated

Summary

Retrieve multiple Company records from Bigin with options to limit the number of results and select specific fields.

Inputs

  • Return All — Boolean flag to decide whether to return all Company records or up to a specified limit.
  • Limit — Maximum number of Company records to return; effective only if 'Return All' is false (default 50, max 50,000).
  • Select All Fields — Boolean flag to select all available fields in the response when true; if false, you can specify which fields to include.
  • Select Fields — List of specific Company fields to include in the returned data when 'Select All Fields' is false.

Output shape

a list of Company records, each containing the fields specified in the input parameters or all fields if 'Select All Fields' is true

If 'Return All' is true, all matching records are returned with pagination handled internally. Up to 50 fields may be returned per record; additional fields beyond 50 are ignored by the Bigin API.

Links

Discussion