Bigin icon

Bigin

Consume Bigin API

Contact → Get Record Deals

AI-generated

Summary

Retrieve deal records associated with specified contacts in Bigin, optionally selecting specific fields.

Inputs

  • Recordid (required) — Specify one or multiple contacts by ID, URL, or searchable list from which to retrieve associated deals.
  • Select All Fields — Choose whether to return all fields of each deal (default true) or select specific fields.
  • Select Field Names or IDs (required) — When 'Select All Fields' is false, specify which deal fields to include in the results using field names or IDs.

Output shape

a list of deal records related to the specified contacts, each containing either all fields or the selected subset of fields

If multiple contacts are specified, deals for all such contacts are aggregated in the output. The returned fields depend on the 'Select All Fields' setting and the chosen field names or IDs. Errors occur if required inputs are missing or invalid.

Examples

Example 1: Fetch all deals associated with a given contact

Set 'Recordid' to the contact's ID or URL; leave 'Select All Fields' checked to retrieve full deal records.

Example 2: Fetch deals with specific fields for multiple contacts

Set 'Recordid' using the Contact list mode with a JSON array of contact records; uncheck 'Select All Fields' and choose specific deal fields to retrieve.

Links

Discussion