Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.portal.io/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint is used by the Portal.io Zapier integration. It fires when a contact (person) record is created, updated, or deleted in your Portal.io account.

Endpoint

GET /zapier/trigger/person

Headers

HeaderRequiredDescription
AcceptYesMust be application/json

Response

A 200 response returns a contact object with the person’s details and their primary location.

Response Fields

FieldTypeDescription
idintegerContact ID.
partyTypestringOne of Undefined, Person, Company.
contactTypestringOne of Undefined, Client, Employee, Contractor, Other.
firstNamestringFirst name.
lastNamestringLast name.
companyNamestringCompany name, when applicable.
contactEmailstringPrimary email address.
contactEmailCCstringCC email address.
contactPhonestringPrimary phone number.
locationobject or nullPrimary location (see location fields).

Location Fields

FieldTypeDescription
idintegerLocation ID.
streetstringStreet address.
suitestringSuite or unit number.
citystringCity.
postalCodestringZIP or postal code.
statestringFull state name.
stateAbbrevstringTwo-letter state abbreviation.
countrystringCountry name.
phonestringLocation phone number.
{
  "id": 88,
  "partyType": "Person",
  "contactType": "Client",
  "firstName": "Jane",
  "lastName": "Smith",
  "companyName": "",
  "contactEmail": "jane.smith@example.com",
  "contactEmailCC": "",
  "contactPhone": "(555) 123-4567",
  "location": {
    "id": 1,
    "street": "123 Main St",
    "suite": "Apt 4B",
    "city": "Austin",
    "postalCode": "78701",
    "state": "Texas",
    "stateAbbrev": "TX",
    "country": "United States",
    "phone": "(555) 123-4567"
  }
}
This endpoint is designed for the Portal.io Zapier integration. If you are building a direct integration, consider using the webhook subscription endpoints instead.