Skip to main content
The field matrix is a field-by-field inventory of the Portal.io public API, organized by domain area. It is designed for integration partners who need to plan mappings between Portal.io and their own system (ERP, CRM, accounting, etc.).

​
What’s included

The spreadsheet contains six tabs:
  • Overview — Base URLs, tab legend, and field context definitions
  • Authentication — HMAC headers, credential exchange request and response fields
  • People & Locations — Contact list, detail, and create fields; location list and create fields; the full location object shape
  • Proposals — Proposal list, detail, create, update, assignment, area, and option fields; the financial summary object
  • Catalog — Catalog search, item detail, supplier cost, and category hierarchy fields
  • Webhooks & Events — Webhook subscription management and event payload fields for all event types
Every field includes its data type, which endpoint it belongs to, whether it is a request or response field, and a description.
Proposal line items are not in the spreadsheet yet. For those fields, use reading proposal items and the Proposal Items reference.
View the Portal.io API Field Matrix (Google Sheets)

​
How to use it

Add a column for your system’s corresponding field (e.g. res.partner.email in Odoo, Contact.Email in Salesforce) and work through each row to define your mapping. The “Context” column tells you whether a field is something you send to Portal.io or something Portal.io returns to you, which determines the direction of your sync. For full endpoint documentation including authentication setup, code samples, and error handling, see the API Reference and Authentication sections.