Jump to Content
People Data LabsDocumentationAPI DashboardAPI StatusRoadmapSupport
HomeDocumentationRecipesRelease Notes
Schema 5

DocumentationAPI DashboardAPI StatusRoadmapSupportStart BuildingLog InPeople Data Labs
Documentation
Start BuildingLog In
Schema 5HomeDocumentationRecipesRelease Notes
All
Pages
Start typing to search…

General

  • Intro
  • Release Notes
  • Data Accuracy
  • Data Build Process
  • Data Sources & Compliance
  • Data Updates
  • Security

API Overview

  • Quickstart
    • Create an account
    • Send your first Person Enrichment API request
    • Send your first Company Enrichment API request
    • Quickstart wrap up
    • API Dashboard Quickstart
  • API Structure & Access
  • Authentication
  • Endpoints
    • Person Endpoints
    • Company Endpoints
    • IP Endpoint
    • Supporting Endpoints
  • Request Parameters
  • Usage Limits
  • Errors & Status Codes

Person Data

  • Person Data Overview
  • Person Data Field Bundles
  • Person Schema
    • Elasticsearch Mapping
  • Person Stats
    • All Dataset Stats
    • Consumer Social Stats
    • Developer Stats
    • Email Stats
    • Mobile Phone Stats
    • Phone Stats
    • Resume Stats
    • Street Address Stats
    • Aggregations by Country
    • Aggregations by Social Network
  • Example Person Record

Person API

  • Person Enrichment API
    • Quickstart - Person Enrichment API
    • Reference - Person Enrichment API
    • Input Parameters - Person Enrichment API
    • Output Response - Person Enrichment API
    • Examples - Person Enrichment API
    • FAQs - Person Enrichment API
    • Bulk Person Enrichment API
    • Preview Enrichment API
  • Person Identify API
    • Quickstart - Person Identify API
    • Reference - Person Identify API
    • Input Parameters - Person Identify API
    • Output Response - Person Identify API
    • Examples - Person Identify API
    • FAQs - Person Identify API
  • Person Search API
    • Quickstart - Person Search API
    • Reference - Person Search API
    • Input Parameters - Person Search API
    • Output Response - Person Search API
    • Examples - Person Search API
    • FAQs - Person Search API
    • Preview Search API

Company Data

  • Company Data Overview
  • Company Data Field Bundles
  • Company Schema
    • Elasticsearch Mapping
  • Company Stats
    • Aggregations by Country
  • Example Company Record

Company API

  • Company Enrichment API
    • Quickstart - Company Enrichment API
    • Reference - Company Enrichment API
    • Input Parameters - Company Enrichment API
    • Output Response - Company Enrichment API
    • Examples - Company Enrichment API
    • FAQs - Company Enrichment API
    • Bulk Company Enrichment API
  • Company Search API
    • Quickstart - Company Search API
    • Reference - Company Search API
    • Input Parameters - Company Search API
    • Output Response - Company Search API
    • Examples - Company Search API
    • FAQs - Company Search API

IP Data

  • IP Data Overview
  • IP Schema
  • IP Stats
    • IP Locations by Country
    • CIDR Locations by Country
  • Example IP Record

IP API

  • IP Enrichment API
    • Quickstart - IP Enrichment API
    • Reference - IP Enrichment API
    • Input Parameters - IP Enrichment API
    • Output Response - IP Enrichment API
    • Examples - IP Enrichment API

Job Posting Data

  • Job Posting Data Overview
  • Job Posting Schema
  • Job Posting Stats
    • Job Posting Locations by Country
  • Example Job Posting Record

Supporting APIs

  • Autocomplete API
    • Quickstart - Autocomplete API
    • Reference - Autocomplete API
    • Input Parameters - Autocomplete API
    • Output Response - Autocomplete API
    • Examples - Autocomplete API
    • FAQs - Autocomplete API
  • Cleaner APIs
    • Quickstart - Cleaner APIs
    • Reference - Cleaner APIs
    • Input Parameters - Cleaner APIs
    • Output Responses - Cleaner APIs
    • Examples - Cleaner APIs
  • Job Title Enrichment API
    • Quickstart - Job Title Enrichment API
    • Reference - Job Title Enrichment API
    • Input Parameters - Job Title Enrichment API
    • Output Response - Job Title Enrichment API
    • Examples - Job Title Enrichment API
  • Sandbox API Endpoints
    • Reference - Sandbox APIs
    • Examples - Sandbox APIs
  • Skill Enrichment API
    • Quickstart - Skill Enrichment API
    • Reference - Skill Enrichment API
    • Input Parameters - Skill Enrichment API
    • Output Response - Skill Enrichment API
    • Examples - Skill Enrichment API
  • Person Changelog API
    • Reference - Person Changelog API
    • Input Parameters - Person Changelog API
    • Output Response - Person Changelog API
    • Examples - Person Changelog API
    • FAQs - Person Changelog API
  • Subject Request API

Data Standardization

  • Canonical Field Values
    • Affiliated Entities - Relationship Catalysts
    • Affiliated Entities - Relationship Statuses
    • Affiliated Entities - Relationship Types
    • Company Sizes
    • Company Types
    • Confidence Levels
    • Currency Codes
    • Education Degrees
    • Education Majors
    • Education School Types
    • Email Types
    • Funding Rounds
    • Sex
    • Industries
    • Industries (V2)
    • Inferred Revenue Ranges
    • Inferred Salaries
    • Job Title Levels
    • Job Title Class
    • Job Title Roles
      • Legacy Job Title Roles (pre-v27.1)
    • Job Title Subroles
      • Legacy Job Title Subroles (pre-v27.1)
    • Language Names
    • Location Continents
    • Location Countries
    • Location Metros
    • Mapping Job Title Class to Roles to Subroles
      • Legacy Mapping Title Subroles to Roles (pre-v27.1)
    • MIC Codes
    • NAICS Codes
    • NAICS Industries
    • NAICS Industry Groups
    • NAICS National Industries
    • NAICS Sectors
    • NAICS Subsectors
    • Profile Networks
    • Remote Work Policies
    • SIC Industry Groups
    • SIC Industry Sectors
    • SIC Major Groups
    • Salary Periods
  • Data Types
  • Data Formatting
  • Employee Count Fields
  • Persistent IDs

Free Datasets

  • Free Company Dataset

Libraries

  • Python SDK
  • JavaScript SDK
  • Ruby SDK
  • Go SDK
  • Rust SDK
  • React Component for Autocomplete

Integrations

  • Salesforce Integration
    • Mappings
    • Enrichment Settings
    • App Settings
    • Setup & Configuration
      • Salesforce Installation & Configuration
      • API Dashboard Setup
      • Verify Enrichment Workflows
      • Troubleshooting
  • Make.com Integration
    • How To Sign Up for a Make.com account
    • How To Authenticate Our APIs Within a Make.com Scenario
  • Zapier Integration
    • How To Sign Up for a Zapier Account
    • How To Authenticate Our APIs Within a Zap

Resources

  • Email Data for Outreach
  • Webhooks
  • Product Integration Guides

Data License

  • Data License Overview
  • Getting Started with a Data License
  • Receiving and Updating Data
    • Data Delivery Using S3
    • Data Delivery Using Snowflake
    • Data Delivery Using Azure
    • Data Delivery Using GCP
    • Data Delivery Using Direct Download
    • Person Changelog
    • Company Changelog
      • Company Changelog Fields
  • Delta File Deliveries
  • Table (Flattened) Data License Format
  • Daily Deliveries (Job Posting Data)

Support

  • Help Center

Affiliated Entities - Relationship Statuses

Canonical Values for Affiliated Entity Relationship Statuses
active
inactive
pending
unknown

Relevant fields

  • affiliated_entities

Updated 3 months ago


Affiliated Entities - Relationship Catalysts
Affiliated Entities - Relationship Types