People

Documentation Index

Fetch the complete documentation index at: https://docs.wellapp.ai/llms.txt

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

​

API operations

​

Data model

​

Attributes

​

Relationships

​

System-computed

• person_id is generated by PostgreSQL gen_random_uuid() as a column default; unique constraint peoples_person_id_unique enforced at the DB level.
• created_at is set via MikroORM onCreate lifecycle hook (new Date()); never updated after first persist.
• updated_at is set on both onCreate and onUpdate via MikroORM lifecycle hooks; reflects the last modification timestamp.
• deleted_at is null for active records; set to a timestamp on soft-delete. The partial unique index on (external_person_id, workspace_pk) excludes rows where deleted_at IS NOT NULL, allowing soft-deleted records to be re-created with the same external_person_id.
• external_person_id is the deduplication key for connector-driven sync: if a sync provides an external_person_id already present in the workspace (under the partial unique constraint), the reconciliation pipeline updates the existing record rather than creating a new one.
• sourceWorkspaceConnector is set by the sync pipeline at creation time to record which WorkspaceConnector produced this record; NULL for manually created people.
• The @Enrichable decorator on job_title, phones, and webLinks marks these fields as candidates for AI enrichment via the enrichment pipeline (Cloud Tasks workers).
• Two partial indexes are maintained by migrations for the records-page query path: idx_peoples_workspace_deleted (workspace_pk WHERE deleted_at IS NULL) and idx_peoples_workspace_created_active (workspace_pk, created_at DESC WHERE deleted_at IS NULL) for default sort order.
• The composite_avatar_fullname composite field (source_fields: person_id, media.url, full_name; display_type: people_avatar_name) is materialized at query time by the data-views pipeline — it is not a persisted column.
• The sourceWorkspaceConnector.composite_connector_logo_name composite (source_fields: workspace_connector_id, connector.service_id, connector.name; display_type: connector_logo_name) is likewise a query-time composite on the people records root.

​

Example

{
  "data": {
    "type": "people",
    "id": "a3f1c2d4-7e89-4b10-bcd2-1f234567890a",
    "attributes": {
      "person_id": "a3f1c2d4-7e89-4b10-bcd2-1f234567890a",
      "full_name": "Sophie Marotremy",
      "first_name": "Sophie",
      "last_name": "Marotremy",
      "job_title": "Head of Finance",
      "external_person_id": "crm_contact_0049281",
      "created_at": "2025-11-03T09:14:22.000Z",
      "updated_at": "2026-03-17T14:55:10.000Z",
      "deleted_at": null
    },
    "relationships": {
      "workspace": {
        "data": { "type": "workspace", "id": "f9e2a1b3-0000-4c2d-8888-aabbccddeeff" }
      },
      "source_workspace_connector": {
        "data": { "type": "workspace_connector", "id": "7a123456-dead-beef-cafe-000000000001" }
      },
      "media": {
        "data": { "type": "media", "id": "bb887766-5544-3322-1100-aabbccddeeff" }
      },
      "emails": {
        "data": [
          { "type": "person_email", "id": "11223344-aaaa-bbbb-cccc-000000000001" }
        ]
      },
      "phones": {
        "data": [
          { "type": "person_phone", "id": "55667788-aaaa-bbbb-cccc-000000000001" }
        ]
      },
      "locations": {
        "data": [
          { "type": "person_location", "id": "99aabbcc-aaaa-bbbb-cccc-000000000001" }
        ]
      },
      "web_links": {
        "data": [
          { "type": "person_web_link", "id": "ddeeff00-aaaa-bbbb-cccc-000000000001" }
        ]
      },
      "companies": {
        "data": [
          { "type": "company_person", "id": "fa1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d" }
        ]
      },
      "memberships": {
        "data": []
      }
    }
  }
}