Overview

Person is a top-level Field Model V1 Directory entity, managed through the unified entity CRUD endpoints at /api/v1/external/companies/{companyId}/entities/Person. Like all FMV1 entities, the set of available fields is configured per company. Key Concepts:

• The request body for create and update is a flat JSON object where keys are field referenceIds (e.g., name, email).
• Responses use the generic entity envelope — all field values live inside a fieldModelV1Data object, alongside id, createdAt/createdBy, updatedAt/updatedBy, and resolved createdByName/updatedByName.
• Updates use merge semantics — provided fields are merged onto the existing data, a key set to null clears that field, and omitted fields are left unchanged. PUT is accepted as an alias for PATCH.
• Person uses the company.fmv1_custom_object:* permission family for all operations.

---

​

Field Discovery

Discover the available Person fields, their types, and which are required via the unified entity configuration endpoint: GET /api/v1/external/companies/{companyId}/entities/person/configuration.

---

​

API Endpoints

The Person endpoints are listed in the left navigation: create and list (POST / GET on /entities/Person), and get, update (PATCH, PUT alias), and delete (GET / PATCH / DELETE on /entities/Person/{entityId}).

---

​

Permissions