Manage companies and their relationships with people within your Well organization. Companies can have multiple people with different relationship types, along with associated social links, emails, and other contact information.

​
Getting Started

The Companies API allows you to create and manage company records, establish relationships with people, and handle company-specific contact information.

Create your first Company

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

​
How Company Management Works

  1. Create companies: Add company records with metadata and optional people relationships
  2. Manage relationships: Link multiple people to companies with specific relationship types
  3. Contact information: Add emails, social links, and other contact details
  4. Organization scoped: Companies are scoped to your organization for security
  5. Lifecycle management: Track creation, updates, and deletion events

​
Company Relationship Types

When linking people to companies, you can specify their relationship type:
  • 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 (default value)

​
Quick Start Examples

// Create a company with multiple people
const response = await fetch('https://api.wellapp.ai/v1/companies', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer your-api-key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    data: {
      type: 'company',
      attributes: {
        name: 'TechCorp Solutions',
        description: 'An innovative technology company',
        partner_id: '34fb3bbc-cc56-4400-ac89-8cda94add38e'
      },
      relationships: {
        people: {
          data: [
            {
              type: 'people',
              id: 'temp-owner-1',
              meta: {
                relationship_type: 'owner'
              }
            },
            {
              type: 'people',
              id: 'temp-employee-1',
              meta: {
                relationship_type: 'employee'
              }
            }
          ]
        }
      }
    },
    included: [
      {
        type: 'people',
        id: 'temp-owner-1',
        attributes: {
          first_name: 'John',
          last_name: 'Doe'
        }
      },
      {
        type: 'people',
        id: 'temp-employee-1',
        attributes: {
          first_name: 'Sarah',
          last_name: 'Martin'
        }
      }
    ]
  })
});

​
Key Features

  • JSON:API Standard: All endpoints follow JSON:API specification for consistency
  • Multiple Relationships: Link multiple people to companies with different relationship types
  • Optional Relationship Types: relationship_type is optional and defaults to ‘other’
  • Bulk Operations: Link multiple people to companies in single requests
  • Contact Information: Manage emails, social links, and other contact details
  • Organization Scoped: All operations are scoped to your organization

​
Available Endpoints

Create Company

Create a new company with optional people relationships

Get Company

Retrieve company details by ID

Update Company

Update company information

Delete Company

Delete a company record

Add People to Company

Link existing people to a company with relationship types

Create Social Link

Add social media links to a company

Get Social Links

Retrieve all social links for a company

Delete Social Link

Remove a social link from a company

Create Email

Add email addresses to a company

Get Emails

Retrieve all emails for a company

Delete Email

Remove an email from a company