Enriches person information using LinkedIn URL, email, and other optional details

Enrich person information

Comprehensive enriched information about a person

List of email addresses associated with the person
required: false

Geographic location information
required: false

URL to person's profile picture
required: false
format: uri

Discord username with discriminator
required: true
pattern: ^.{3,32}#[0-9]{4}$

Email address
required: true
format: email

Indicates if the email is deliverable
required: false

Indicates if the email is considered risky
required: false

Type of email address
required: false
enum: personal,work

Full GitHub profile URL
required: false
format: uri

Company's LinkedIn URL
required: false
format: uri

Company's website
required: false
format: uri

Indicates if this is the current position
required: true

Seniority level
required: false
enum: Junior,Mid-Level,Senior,Lead,Manager,Director,VP,C-Level

Ending month (1-12)
required: false
minimum: 1
maximum: 12

Ending year
required: false
minimum: 1900
maximum: 2100

Starting month (1-12)
required: false
minimum: 1
maximum: 12

Starting year
required: false
minimum: 1900
maximum: 2100

Number of LinkedIn followers
required: false
minimum: 0

LinkedIn public identifier
required: false

Full LinkedIn profile URL
required: false
format: uri

Geographic and timezone information about a person

Timezone identifier
required: false
example: America/Los_Angeles

Full name (typically firstName + lastName)
required: false

Phone number in E.164 format
required: true
pattern: ^\+[1-9]\d{1,14}$

Type of phone number
required: true
enum: mobile,work,home,other

Collection of social media profile information

Discord profile information
required: false

GitHub profile information
required: false

LinkedIn profile information
required: false

X (Twitter) profile information
required: false

Full X profile URL
required: false
format: uri

ApiKeyAuth

Processing initiated, check ResultURL for final data

Response structure for person enrichment operations

Standard response structure for API operations

CustomerOS Docs

Empower your sales team, uncover opportunities, and grow revenue with the all-in-one AI platform for sales, support and success.

Introduction

CustomerOS

Understand the CustomerOS data model and it's standard objects

Data Model

Company Timelines are where your whole team can get an up to date picture of every customer in seconds.

Timeline

Search and sort data objects using tables and kanban boards.

Views

Inbox

Send & Receive Email

A quickstart guide to issue your first invoice and collect payment with CustomerOS

Bill & Invoice

Use tags to easily group your data for use by flows or user specific tasks.

Agents

Automate your invoicing, payments, cash collection and accounting in one place

Cashflow Guardian

Let an agent research companies for you and match them with your qualified ICP

ICP Qualifier

Email Drip Agent

LinkedIn Automation

Identify Website Visitors

Data Enrichment

Companies are used to manage the Companies that you want to engage with

Companies

Contacts

Users

Use Opportunties to manage and drive your revenue pipeline.

Opportunities

Tasks

Issues

Products represent what you sell to your customers for contracting, invoicing and reporting purposes.

Products

Contracts

Invoices

Workspaces & Users

Get notified the moment customers and prospects require your teams attention

Notifications

Use Custom Fields to help track specific information against your customers

Custom Fields

Reporting

Automatically update your Accounting system with invoices from CustomerOS

Accounting

CustomerOS maintains a strong security posture as one of it\'s highest values

Security & Compliance

Supercharge your GTM tooling by integrating your software with CustomerOS

API Overview

Everything that you can do in CustomerOS you can access via API

API Descriptions

Notify your app when certain events occur

Webhooks

Bring life to CustomerOS by integrating your favourite tools

Connect your accounts to automate and orchestrate your LinkedIn presence

LinkedIn

Slack

Salesforce.com

Hubspot

Close

Collect Form signups from Framer Forms using webhooks to create contacts and companies in CustomerOS

Framer

Collect Form signups from Webflow Forms using webhooks to create contacts and companies in CustomerOS

Webflow

Gmail

Outlook

Cal.com

Integrating Fathom with CustomerOS using Zapier

Fathom

Integrating Grain with CustomerOS using Zapier

Grain

Fireflies

Zendesk

Intercom

Set up Stripe as a payment gateway for CustomerOS invoices

Stripe

Become your own payment processor using CustomerOS

BYO Payment Provider

Xero

Quickbooks Online (QBO)

Creates a contact from either JSON or CSV upload

Create a new contact

Creates multiple contacts from JSON input

Create multiple contacts

Creates multiple contacts from CSV file upload

Import contacts from CSV

Creates an organization if it doesn't exist based on website, custom ID, or LinkedIn URL. Returns existing organization if found.

Create a new organization

Retrieves detailed organization information by ID or COS ID

Get organization details

Sets or updates the primary external system identifier for an organization

Set primary external system ID

Enriches organization information using either domain or LinkedIn URL

Enrich organization information

Retrieves the results of an asynchronous person enrichment operation

Retrieve enrichment results

Performs comprehensive validation of a single email address

Verify single email address

Initiates bulk verification process for emails from CSV file

Upload emails for bulk verification

Retrieves results or status of bulk verification job

Get bulk verification results

Downloads CSV file containing detailed verification results

Download bulk verification results

Retrieves comprehensive information about an IP address including threats, geolocation, and network details

Get IP intelligence data

Retrieves all active domains for the authenticated tenant

List active domains

Registers and configures a new domain for mail services, including DNS setup

Register new domain

Sets up DNS records and mail services for an existing domain

Configure domain DNS

Retrieves all mailboxes configured for the specified domain

List mailboxes

Creates a new mailbox for the specified domain with optional forwarding and webmail access

Create mailbox

Retrieves all non-dry-run invoices for a specific organization, sorted by due date descending

Get organization's invoices

The only CRM you need for sales, support and success.

Use Agents to automate almost all your customer facing workflows so you can focus on what matters

Mailstack

Let CustomerOS optimise email deliverability from your domains directly

Enrichment API

Enrich person information

Authorizations

Query Parameters

Response