Manage people and their associated contact information within your Well organization. People can have multiple emails, phone numbers, social links, and relationships with companies.

​
Getting Started

The People API allows you to create and manage person records, establish relationships with companies, and handle personal contact information.

Create your first Person

Start by creating a person with basic information and optional company relationships

​
How People Management Works

  1. Create people: Add person records with metadata and optional company relationships
  2. Manage contact info: Add emails, phone numbers, and social links to people
  3. Company relationships: Link people to companies with specific roles
  4. Organization scoped: People are scoped to your organization for security
  5. Lifecycle management: Track creation, updates, and deletion events

​
Person-Company Relationship Types

When linking people to companies, you can specify their relationship:
  • Owner: Person who owns or founded the company
  • Employee: Person who works at the company
  • Contact: Person who is a contact point for the company
  • Other: Any other type of relationship

​
Contact Information Types

​
Email Labels

  • Work: Professional email address
  • Personal: Personal email address
  • Other: Any other type of email

​
Phone Labels

  • Mobile: Mobile phone number
  • Work: Work phone number
  • Home: Home phone number
  • Other: Any other type of phone

​
Social Platform Support

  • Twitter/X: Twitter or X profiles
  • LinkedIn: LinkedIn profiles
  • GitHub: GitHub profiles

​
Quick Start Examples

// Create a person with contact info and company relationships
const response = await fetch('https://api.wellapp.ai/v1/people', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer your-api-key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    data: {
      type: 'people',
      attributes: {
        first_name: 'John',
        last_name: 'Doe',
        job_title: 'Software Engineer'
      },
      relationships: {
        emails: {
          data: [{ type: 'emails', id: 'temp-email-1' }]
        },
        companies: {
          data: [{ type: 'companies', id: 'temp-company-1' }]
        }
      }
    },
    included: [
      {
        type: 'emails',
        id: 'temp-email-1',
        attributes: {
          value: 'john.doe@example.com',
          label: 'work'
        }
      },
      {
        type: 'companies',
        id: 'temp-company-1',
        attributes: {
          name: 'Tech Corp',
          role: 'employee',
          partner_id: 'partner-uuid'
        }
      }
    ]
  })
});

​
Key Features

  • JSON:API Standard: All endpoints follow JSON:API specification for consistency
  • Rich Contact Info: Support for multiple emails, phones, and social links per person
  • Company Relationships: Create and manage complex relationships between people and companies
  • Bulk Operations: Create people with associated contact info and companies in single requests
  • Filtering & Pagination: Efficient data retrieval with query parameters