Jump to Content

Documentation API Dashboard API Status Roadmap Support

Home Documentation Recipes Release Notes

v5.0

Documentation API Dashboard API Status Roadmap Support Start Building Log In

Documentation

Start Building Log In

Schema 5Home Documentation Recipes Release 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
API Structure & Access
Authentication
Endpoints
Request Parameters
Usage Limits
Errors & Status Codes

Person Data

Person Data Overview
Person Data Field Bundles
Person Schema
- Elasticsearch Mapping
Person Stats
Example Person Record

Person API

Person Enrichment API
Person Identify API
Person 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
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

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
Cleaner APIs
Job Title Enrichment API
Sandbox API Endpoints
- Reference - Sandbox APIs
- Examples - Sandbox APIs
Skill Enrichment API
Person Changelog API
Subject Request API

Data Standardization

Canonical Field Values
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
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

Webhooks
Product Integration Guides

Data License

Data License Overview
Getting Started with a Data License
Receiving and Updating Data
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 about 11 hours ago

Affiliated Entities - Relationship Catalysts

Affiliated Entities - Relationship Types

Table of Contents
- Relevant fields