Bigin icon

Bigin

Consume Bigin API

Contact → Get

AI-generated

Summary

Retrieve one or multiple contacts from Bigin by specifying their IDs, URLs, or via a search list, optionally selecting all fields or a specified subset of up to 50 fields.

Inputs

  • Recordid (required) — Select the contact(s) to retrieve by ID, URL, or searchable list.
  • Selectallfields (required) — Choose whether to select all fields (default) or specific fields for each contact.
  • Selectfields — When not selecting all fields, specify which fields (e.g., Name, Owner, Created_Time) to include in the result.
  • Recordlist — Used when input mode is 'Many'; paste a JSON array of contact records to retrieve multiple contacts.

Output shape

A single contact record's data or multiple contact records as JSON objects, depending on input mode and selection; includes only the requested fields with a maximum of 50 fields per contact.

When selecting specific fields, Bigin limits to 50 fields per request, skipping any extras. Input mode distinguishes single contact retrieval or multiple contacts via JSON array input. Search list supports filter-based selection with a required search filter and a 10 second timeout.

Links

Discussion