Bigin icon

Bigin

Consume Bigin API

Company → Get Company Deals

AI-generated

Summary

Retrieve deals associated with a specified Company in Bigin by providing the Company record ID, URL, or search from a list. Optionally select all deal fields or specify particular fields to include in the returned deal data.

Inputs

  • Recordid (required) — Select the Company record by ID, URL, or from a searchable list of Companies to retrieve associated deals.
  • Select All Fields — Choose whether to retrieve all deal fields (default true) or select specific fields.
  • Select Field Names or IDs — If not selecting all fields, specify which deal fields to include in the results by choosing from provided options or using expressions.

Output shape

a list of deal records associated with the specified Company, each including the requested fields.

Returns all deals related to the Company record specified. Field selection controls which attributes are included per deal. Pagination or batch handling is not detailed, assume full retrieval of associated deals per invocation.

Examples

Example 1: Retrieve all deals for a Company by ID

Set Recordid to the Company's ID and leave 'Select All Fields' checked to get all deal details.

Example 2: Retrieve specific deal fields for a Company found via URL

Set Recordid using the Company URL, uncheck 'Select All Fields', and specify required fields in 'Select Field Names or IDs'.

Links

Discussion