The Scenario
You are a developer building a CRM data-sync tool for a client. Your sync tool needs to know every field in the Bigin Contacts module — the API name, the data type, whether the field is mandatory — before it can construct a valid import payload.
The Bigin documentation covers the common fields. It does not give you a machine-readable list of every field, especially the custom ones the client added to their Bigin instance. The only way to get the full list is to call the Bigin field metadata API.
You would rather have the output in an Excel workbook than parse a JSON blob in a terminal.
The bad version:
- Write a curl command to call the Bigin fields API, pipe the output to jq, and extract the field name, type, and required flag.
- Copy the terminal output into a text editor, manually clean up the formatting, and paste into a workbook row by row.
- Realize the client's custom fields have API names like "CUST_MODULE_17" with no display name in the raw API response, and go back to the documentation to figure out which field is which.
The data is available. Getting it into a usable shape is the work.
The Easy Way: One Prompt in SheetXAI
SheetXAI is an AI agent that lives inside your Excel workbook. It calls the Bigin field metadata API for the module you specify and writes the results directly into your workbook — no curl, no JSON parsing, no copy-pasting.
List all fields available in the Bigin Pipelines module — display name, API name, field type, and whether it is mandatory — and write them to my Excel table
What You Get
- One row per field in the Bigin module, with columns for API Name, Display Name, Data Type, and Required (true/false).
- Custom fields included alongside standard fields — labeled with their display names where available.
- The workbook is ready to use as the mapping reference for your sync tool's import payload builder.
What If the Data Is Not Quite Ready
You need fields for multiple modules, not just one
Fetch field metadata for both the Bigin Contacts module and the Bigin Pipelines module. Write Contacts fields into the "Contacts Fields" worksheet and Pipelines fields into the "Pipelines Fields" worksheet. Include API name, display name, data type, and required flag for each.
You want to flag which fields have picklist values
Fetch field metadata for the Bigin Contacts module. Write API name, display name, data type, and required flag into this workbook. For fields where data type is "picklist" or "multi-select", also write the allowed values into column E as a comma-separated list.
You need to compare the current Bigin schema against a previous snapshot to detect added or removed fields
Fetch current field metadata for the Bigin Contacts module and write API name, data type, and required flag into columns A through C starting at row 2. Then compare each API name against the list in the "Snapshot" worksheet column A — mark NEW in column D if it is not in the snapshot, REMOVED in the snapshot worksheet if a snapshot field is not in the current list.
Full metadata fetch with type classification for import tool in one shot
Fetch all fields for the Bigin Contacts module. For each field, write: Display Name (column A), API Name (column B), Data Type (column C), Required (column D). For picklist fields, also write allowed values in column E. Sort by Required descending so mandatory fields appear first.
One prompt delivers the schema reference your sync tool needs — no API exploration required.
Try It
Get the 7-day free trial of SheetXAI and open a blank Excel workbook, then ask SheetXAI to fetch the Bigin Contacts field metadata. If you want to use that schema to bulk-import contacts immediately after, see the spoke on bulk-importing contacts from a workbook.