Enrich Layer

https://enrichlayer.com/docs
Admin
Enrich Layer is a fully-managed API that provides tools for looking up and enriching people and...
Tokens:22,123
Snippets:384
Trust Score:6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Get How-To Guides

Source: https://enrichlayer.com/docs/cli/commands

Retrieve guidance and recipes for specific topics within Enrich Layer.

```bash
el how-to [topic]
```

--------------------------------

### Install Enrich Layer CLI

Source: https://enrichlayer.com/docs/cli/getting-started

Install the CLI globally using npm, Bun, or Yarn. This makes the 'el' and 'enrichlayer' binaries available on your system.

```bash
npm install -g enrichlayer-cli
```

```bash
# Bun
bun install -g enrichlayer-cli

# Yarn
yarn global add enrichlayer-cli
```

--------------------------------

### Autocomplete API Example Request

Source: https://enrichlayer.com/docs/api-v3/autocomplete-api

This example shows how to make a request to the Autocomplete API using curl. Replace 'YOUR_API_KEY' with your actual API key.

```Bash
curl "https://enrichlayer.com/api/v3/company/search?q=netflix" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

--------------------------------

### Logo API Example Request

Source: https://enrichlayer.com/docs/api-v3/logo-api

Example cURL command to make a request to the Logo API, including the query parameter and authorization header.

```bash
curl "https://enrichlayer.com/api/v3/company/logo?q=stripe.com" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

--------------------------------

### Multiple Items API Log Example

Source: https://enrichlayer.com/docs/guides/credits

An example API log for an employee listing with premium parameters, showing the total cost including base, premium, and item-specific costs.

```json
{
    "role_search": 10,
    "sort_by": 50,
    "items": 57,
    "items_count": 3,
    "items_breakdown": {
        "base_cost": 3,
        "role_search": 3,
        "sort_by": 10,
        "countries": 3
    }
}
```

--------------------------------

### Example API Response with ISO 8601 Dates

Source: https://enrichlayer.com/docs/guides/iso8601-date-format

A typical API response demonstrates different precision levels for start and end dates in experience and education fields. Null end dates indicate ongoing activities.

```json
{
  "experience": [
    {
      "title": "Senior Engineer",
      "company": "Acme Corp",
      "start_date": "2021-06",
      "end_date": null
    },
    {
      "title": "Engineer",
      "company": "Startup Inc",
      "start_date": "2018-09-01",
      "end_date": "2021-05"
    }
  ],
  "education": [
    {
      "school": "MIT",
      "start_date": "2014",
      "end_date": "2018"
    }
  ]
}
```

--------------------------------

### Single Item API Log Example

Source: https://enrichlayer.com/docs/guides/credits

An example of an API log entry for a single item response, showing the credit cost breakdown for base and premium parameters.

```json
{
    "base_cost": 1,
    "extra_data": 1,
    "github_profile_id": 1,
    "facebook_profile_id": 1,
    "twitter_profile_id": 1,
    "live_fetch": 9
}
```

--------------------------------

### Multiple Items API Request Example

Source: https://enrichlayer.com/docs/guides/credits

Demonstrates a cURL request to the company/employees endpoint for a multiple item response. This example includes parameters for filtering and sorting.

```shell
curl \
    -G "https://enrichlayer.com/api/v2/company/employees" \
    -H "Authorization: Bearer ${YOUR_API_KEY}" \
    --data-urlencode "url=https://www.linkedin.com/company/microsoft" \
    --data-urlencode "country=ca" \
    --data-urlencode "boolean_role_search=software and engineer" \
    --data-urlencode "sort_by=recently-joined" \
    --data-urlencode "page_size=3"
```

--------------------------------

### Verify Enrich Layer CLI Installation

Source: https://enrichlayer.com/docs/cli

Verify the installation of the Enrich Layer CLI by checking its version. You can use either the short alias 'el' or the full command 'enrichlayer'.

```bash
el --version
# or, equivalent:
enrichlayer --version
```

--------------------------------

### Install Enrich Layer CLI

Source: https://enrichlayer.com/docs/cli

Install the Enrich Layer CLI globally using npm. This command installs the necessary package to use the CLI tools.

```bash
npm install -g enrichlayer-cli
```

--------------------------------

### Combined Logic Example

Source: https://enrichlayer.com/docs/guides/boolean-search-syntax

Search for CTO or Chief Technology Officer roles in startups or Series A funding stages.

```text
(CTO || "chief technology officer") && (startup || "series a")
```

--------------------------------

### Force a Fresh Lookup with `live_fetch=force`

Source: https://enrichlayer.com/docs/knowledge-base/api-usage/data-freshness

This example demonstrates how to force a live lookup, ensuring the most up-to-date data is retrieved. It incurs credit costs even if cached data is available.

```bash
curl -G \
  -H "Authorization: Bearer YOUR_API_KEY" \
  'https://enrichlayer.com/api/v2/profile' \
  --data-urlencode 'profile_url=https://linkedin.com/in/someone/' \
  --data-urlencode 'live_fetch=force'
```

--------------------------------

### Wildcard Example

Source: https://enrichlayer.com/docs/guides/boolean-search-syntax

Use the asterisk wildcard to match partial words (suffix matching). Wildcards cannot lead a query.

```text
star*
```

--------------------------------

### Explore More Enrich Layer CLI Commands

Source: https://enrichlayer.com/docs/cli/getting-started

Examples of various commands for company enrichment, profile lookup, search, contact finding, and checking credit balance.

```bash
# Company enrichment
el company https://linkedin.com/company/microsoft

# Find a person by name and company
el profile lookup --name "Satya Nadella" --company microsoft.com

# Search for engineers at Google
el search person --company Google --title Engineer --limit 20

# Find a work email
el contact work-email https://linkedin.com/in/satyanadella

# Check your credit balance
el credits
```

--------------------------------

### Grouping Example

Source: https://enrichlayer.com/docs/guides/boolean-search-syntax

Use parentheses to group expressions and control the order of evaluation.

```text
(bananas || apples) && bread
```

--------------------------------

### Get Company Picture

Source: https://enrichlayer.com/docs/cli/commands

Fetch the company picture for a given URL.

```bash
el company picture <url>
```

--------------------------------

### Manage CLI Configuration

Source: https://enrichlayer.com/docs/cli/commands

Use `el config` commands to manage CLI-local settings. This includes listing, getting, setting, unsetting, and printing the path to the configuration directory.

```bash
el config list                    # Show all settings
el config get <key>               # Read a setting
el config set <key> <value>       # Write a setting
el config unset <key>             # Remove a setting
el config path                    # Print the config directory path
```

--------------------------------

### AND Operator Example

Source: https://enrichlayer.com/docs/guides/boolean-search-syntax

Use the AND operator to find results that include all specified keywords.

```text
bananas && apples
```

--------------------------------

### Get Profile Picture

Source: https://enrichlayer.com/docs/cli/commands

Fetch the profile picture for a given URL.

```bash
el profile picture <url>
```

--------------------------------

### Example Person Profile API Response

Source: https://enrichlayer.com/docs/knowledge-base/getting-started/quickstart

This is an example of the JSON response you will receive after making a successful Person Profile API call. It contains structured professional and educational details.

```json
{
  "full_name": "Satya Nadella",
  "headline": "Chairman and CEO at Microsoft",
  "city": "Redmond",
  "state": "Washington",
  "country_full_name": "United States of America",
  "experiences": [
    {
      "company": "Microsoft",
      "title": "Chairman and Chief Executive Officer",
      "starts_at": { "day": 1, "month": 2, "year": 2014 }
    }
  ],
  "education": [
    {
      "school": "University of Wisconsin-Milwaukee",
      "degree_name": "Master of Science"
    }
  ]
}
```

--------------------------------

### Use Enrich Layer CLI in Scripts

Source: https://enrichlayer.com/docs/cli/getting-started

Examples of using the CLI for automation, including piping output to jq, saving JSON to files, and batch processing with JSON Lines.

```bash
# Auto-JSON when piped
el profile https://linkedin.com/in/satyanadella | jq '.headline'

# Save raw JSON to a file
el profile https://linkedin.com/in/satyanadella --json -o profile.json

# Batch-enrich a file of LinkedIn URLs
el profile --file urls.txt --jsonl > profiles.jsonl

# Save credits by preferring cached data
el profile https://linkedin.com/in/satyanadella --use-cache if-present
```

--------------------------------

### Enrich Profile with Different Output Formats

Source: https://enrichlayer.com/docs/cli/getting-started

Get the complete human-readable view or the raw JSON data for a profile enrichment.

```bash
el profile https://linkedin.com/in/satyanadella --full
el profile https://linkedin.com/in/satyanadella --json
```

--------------------------------

### Multiple Role Variations Example

Source: https://enrichlayer.com/docs/guides/boolean-search-syntax

Search for any VP-level title combined with specific departments.

```text
("vice president" || VP) && (engineering || technology)
```

--------------------------------

### Exact Phrase Example

Source: https://enrichlayer.com/docs/guides/boolean-search-syntax

Wrap terms in double quotes to match an exact phrase.

```text
"banana bread"
```

--------------------------------

### Single Item API Request Example

Source: https://enrichlayer.com/docs/guides/credits

Demonstrates a cURL request to the profile endpoint for a single item response. This includes various parameters that can affect credit usage.

```shell
curl \
    -G "https://enrichlayer.com/api/v2/profile" \
    -H "Authorization: Bearer ${YOUR_API_KEY}" \
    --data-urlencode "profile_url=https://www.linkedin.com/in/williamhgates" \
    --data-urlencode "extra=include" \
    --data-urlencode "github_profile_id=include" \
    --data-urlencode "facebook_profile_id=include" \
    --data-urlencode "twitter_profile_id=include" \
    --data-urlencode "personal_contact_number=include" \
    --data-urlencode "inferred_salary=include" \
    --data-urlencode "skills=include" \
    --data-urlencode "live_fetch=force"
```

--------------------------------

### Get Contact Email

Source: https://enrichlayer.com/docs/cli/commands

Retrieve contact email information.

```bash
el contact email
```

--------------------------------

### OR Operator Example

Source: https://enrichlayer.com/docs/guides/boolean-search-syntax

Use the OR operator to retrieve results containing either of the specified terms.

```text
bananas || apples
```

--------------------------------

### Lookup Company Employee Count

Source: https://enrichlayer.com/docs/cli/commands

Get the number of employees for a given company URL.

```bash
el company employee-count <url>
```

--------------------------------

### Autocomplete API Response Example

Source: https://enrichlayer.com/docs/api-v3/autocomplete-api

The API returns an array of company objects, each containing details like company name, logo URL, domain, industry, employee count, and location. The 'logoUrl' and 'location' fields may be null.

```JSON
[
  {
    "companyName": "Stripe",
    "logoUrl": "https://assets.enrichlayer.com/pp/profilepic/84bd39cc2914d1e0d12f781dba4b888f",
    "domain": {
      "resolved": "stripe.com",
      "original": "stripe.com",
      "alternatives": []
    },
    "industry": "Technology, Information and Internet",
    "employeeCount": 14492,
    "location": {
      "city": "South San Francisco",
      "state": "California",
      "country": "US"
    },
    "linkedinUrl": "https://www.linkedin.com/company/stripe"
  }
]
```

--------------------------------

### Get Company Employee Count

Source: https://enrichlayer.com/docs/cli/commands

Retrieve the total number of employees for a given company URL.

```bash
el company employee-count https://linkedin.com/company/microsoft
```

--------------------------------

### Get LinkedIn School Profile Details

Source: https://enrichlayer.com/docs/cli/commands

Retrieve details for a LinkedIn school profile. The --json flag provides machine-readable output.

```bash
el school https://linkedin.com/school/stanford-university
```

```bash
el school https://linkedin.com/school/stanford-university --json
```

--------------------------------

### Adjusting page_size to Avoid Credit Errors

Source: https://enrichlayer.com/docs/knowledge-base/billing/not-enough-credits-error

When encountering a 'Not Enough Credits' error, reduce the 'page_size' in your request payload to match your available credit balance. This example shows setting page_size to 40.

```json
{
  "page_size": 40
}
```

--------------------------------

### Get Company Profile Data from URL

Source: https://enrichlayer.com/docs/knowledge-base/getting-started/choosing-the-right-endpoint

Use the Company Profile endpoint when you have a company's profile URL to retrieve detailed company information.

```api
GET /api/v2/company?company_url=https://linkedin.com/company/microsoft/
```

--------------------------------

### Get Person Profile Data from URL

Source: https://enrichlayer.com/docs/knowledge-base/getting-started/choosing-the-right-endpoint

Use the Person Profile endpoint when you have a person's profile URL and need comprehensive data like work history, education, and skills.

```api
GET /api/v2/profile?profile_url=https://linkedin.com/in/someone/
```

--------------------------------

### Discover Workflows with 'how-to' Command

Source: https://enrichlayer.com/docs/cli/getting-started

Use the 'el how-to' command to explore recipe snippets for common use cases. Use '--list' to see all recipes and '--json' for a machine-readable catalog.

```bash
el how-to --list              # List every recipe
el how-to lead-gen            # Show a specific recipe
el how-to --list --json       # Machine-readable catalog for agents
```

--------------------------------

### Show all CLI settings

Source: https://enrichlayer.com/docs/cli/configuration

Use this command to view all available configuration settings for the CLI.

```bash
el config list
```

--------------------------------

### GET /api/v3/company/logo

Source: https://enrichlayer.com/docs/api-v3/logo-api

Searches for companies by domain name and returns a list of up to 10 companies sorted by employee count in descending order. Includes company name, logo URL, domain details, industry, employee count, and location.

```APIDOC
## GET /api/v3/company/logo

### Description
Searches for companies by domain name and returns a list of up to 10 companies sorted by employee count in descending order. Includes company name, logo URL, domain details, industry, employee count, and location.

### Method
GET

### Endpoint
/api/v3/company/logo

### Parameters
#### Query Parameters
- **q** (string) - Required - Domain name or partial domain to search for

### Response
#### Success Response (200)
Returns an array of up to 10 companies sorted by employee count (descending).
- **companyName** (string) - The name of the company.
- **logoUrl** (string) - The URL of the company's logo. May be null.
- **domain** (object) - Details about the company's web domain.
  - **domain.resolved** (string) - The registrable domain, normalized from any subdomain match. Null if unknown.
  - **domain.original** (string) - The raw domain the match was found on, which may be a subdomain. Null if unknown.
  - **domain.alternatives** (array) - An array of additional known domains for the company.
- **industry** (string) - The industry the company belongs to.
- **employeeCount** (integer) - The number of employees in the company.
- **location** (object) - Details about the company's location. May be null.
  - **location.city** (string) - The city of the company's location.
  - **location.state** (string) - The state of the company's location.
  - **location.country** (string) - The country of the company's location.
- **linkedinUrl** (string) - The LinkedIn profile URL for the company.

#### Response Example
```json
[
  {
    "companyName": "Stripe",
    "logoUrl": "https://assets.enrichlayer.com/pp/profilepic/84bd39cc2914d1e0d12f781dba4b888f",
    "domain": {
      "resolved": "stripe.com",
      "original": "stripe.com",
      "alternatives": []
    },
    "industry": "Technology, Information and Internet",
    "employeeCount": 14492,
    "location": {
      "city": "South San Francisco",
      "state": "California",
      "country": "US"
    },
    "linkedinUrl": "https://www.linkedin.com/company/stripe"
  }
]
```

### Errors
Status| When  
---|---  
400| `q` parameter is missing or empty  
429| Rate limit exceeded
```

--------------------------------

### Access Recipes for Workflows

Source: https://enrichlayer.com/docs/cli/commands

Display copy-pasteable recipes for common workflows. Use --list to see all available recipes and --json for machine-readable output.

```bash
el how-to --list                    # Show every available recipe
```

```bash
el how-to lead-gen                  # Print a specific recipe
```

```bash
el how-to --list --json             # Machine-readable catalog (for agents)
```

```bash
el how-to cost-saving --json        # A single recipe as JSON
```

--------------------------------

### Discover Workflow Recipes

Source: https://enrichlayer.com/docs/cli

Discover recipes for common workflows such as lead generation and batch enrichment.

```bash
# Discover recipes for common workflows (lead-gen, batch enrichment, …)
el how-to --list
```

--------------------------------

### Fetch First Page of Search Results

Source: https://enrichlayer.com/docs/knowledge-base/api-usage/pagination-and-search

Use this command to retrieve the initial page of search results. Include parameters like 'current_role_title', 'country', and 'page_size' to refine your search.

```bash
# First page
curl -G \
  -H "Authorization: Bearer YOUR_API_KEY" \
  'https://enrichlayer.com/api/v2/search/person' \
  --data-urlencode 'current_role_title=CTO' \
  --data-urlencode 'country=US' \
  --data-urlencode 'page_size=10'
```

--------------------------------

### Employee Title Search Example

Source: https://enrichlayer.com/docs/guides/boolean-search-syntax

Find engineering managers while excluding directors.

```text
"engineering manager" -director
```

--------------------------------

### NOT Operator Example

Source: https://enrichlayer.com/docs/guides/boolean-search-syntax

Use the NOT operator to exclude specific terms from the search results.

```text
bananas -apples
```

--------------------------------

### Manage API Keys

Source: https://enrichlayer.com/docs/cli/commands

Access commands for managing your Enrich Layer API keys.

```bash
el api-keys
```

--------------------------------

### Manage Authentication Subcommands

Source: https://enrichlayer.com/docs/cli/commands

Access subcommands for managing authentication, such as token management.

```bash
el auth <subcommand>
```

--------------------------------

### Get Work Email by URL

Source: https://enrichlayer.com/docs/cli/commands

Retrieve the work email associated with a given URL.

```bash
el contact work-email <url>
```

--------------------------------

### Authenticate with Enrich Layer CLI (Browser)

Source: https://enrichlayer.com/docs/cli/getting-started

Log in using the browser-based authentication flow. This is the simplest method and stores credentials locally.

```bash
el login
```

--------------------------------

### Interactive Login

Source: https://enrichlayer.com/docs/cli/commands

Use `el login` for interactive authentication. It defaults to a browser flow but can be forced with `--browser` or use device code flow with `--device` for environments like SSH or CI.

```bash
el login                    # Interactive (browser by default)
el login --browser          # Force browser flow
el login --device           # Device code flow for SSH / CI
el login --token <key>      # Paste an API key directly
el login --json             # Machine-readable output for scripts
```

--------------------------------

### Broad Keyword with Exclusion Example

Source: https://enrichlayer.com/docs/guides/boolean-search-syntax

Search for 'data scientist' and exclude intern and junior roles.

```text
"data scientist" -intern -junior
```

--------------------------------

### Get Company Logo URL

Source: https://enrichlayer.com/docs/cli/commands

Retrieve the URL of the company's logo from its LinkedIn profile.

```bash
el company picture https://linkedin.com/company/microsoft
```

--------------------------------

### Batch process profiles from a file

Source: https://enrichlayer.com/docs/cli/configuration

Process profile data by reading URLs from a file, with options for JSON Lines output and specifying fields.

```bash
# Read URLs from a file (one per line, blank lines and #-comments are skipped)
el profile --file urls.txt --jsonl > profiles.jsonl

# Read URLs from standard input
cat urls.txt | el profile --stdin --jsonl

# Combine with --output and --fields
el profile --file urls.txt --jsonl --fields full_name,headline -o results.jsonl
```

--------------------------------

### Recommended Production Settings for Cache Control

Source: https://enrichlayer.com/docs/knowledge-base/api-usage/data-freshness

These settings provide fast responses by prioritizing cached data and automatically falling back to the cache if a live lookup fails. This is recommended for most production use cases.

```text
use_cache=if-present&fallback_to_cache=on-error
```

--------------------------------

### Logo API Endpoint

Source: https://enrichlayer.com/docs/api-v3/logo-api

The GET endpoint for the Logo API used to search for companies by domain name.

```http
GET /api/v3/company/logo?q={query}
```

--------------------------------

### Write a single CLI setting

Source: https://enrichlayer.com/docs/cli/configuration

Use this command to set or update a specific CLI configuration setting.

```bash
el config set <key> <value>
```

--------------------------------

### Enable Fish shell completion

Source: https://enrichlayer.com/docs/cli/configuration

Configure tab completion for Enrich Layer CLI commands in Fish by saving the output to the specified file.

```bash
el completion fish > ~/.config/fish/completions/el.fish
```

--------------------------------

### Get LinkedIn Job Details

Source: https://enrichlayer.com/docs/cli/commands

Retrieve details for a specific LinkedIn job posting. Use the --json flag for machine-readable output.

```bash
el job https://linkedin.com/jobs/view/123456789
```

```bash
el job https://linkedin.com/jobs/view/123456789 --json
```

--------------------------------

### Check Credit Balance with cURL

Source: https://enrichlayer.com/docs/knowledge-base/billing/understanding-credits

Use this cURL command to check your remaining credits via the API. Replace 'YOUR_API_KEY' with your actual API key.

```bash
curl -H "Authorization: Bearer YOUR_API_KEY" \
  'https://enrichlayer.com/api/v2/credit-balance'
```

--------------------------------

### Get Profile Picture URL

Source: https://enrichlayer.com/docs/cli/commands

Retrieves the URL for a person's profile picture from a LinkedIn profile URL. Supports JSON output.

```bash
el profile picture https://linkedin.com/in/satyanadella
el profile picture https://linkedin.com/in/satyanadella --json
```

--------------------------------

### Authenticate with Enrich Layer CLI (Device Code Flow)

Source: https://enrichlayer.com/docs/cli/getting-started

Use the device code flow for authentication in headless servers or SSH sessions.

```bash
el login --device
```

--------------------------------

### Manage API Keys

Source: https://enrichlayer.com/docs/cli/commands

Manage your API keys, including listing, creating, and revoking them. Labels are limited to 32 characters and can be created individually or as a comma-separated list.

```bash
el api-keys list                                   # Show all keys (current key is marked)
```

```bash
el api-keys list --format json                     # Machine-readable
```

```bash
el api-keys create --label production              # Create with a single label
```

```bash
el api-keys create --labels "prod,team-alpha"      # Joined into one label
```

```bash
el api-keys create                                 # Create without a label
```

```bash
el api-keys revoke <token>                         # With confirmation prompt
```

```bash
el api-keys revoke <token> --force                 # Skip confirmation
```

--------------------------------

### Show CLI config directory path

Source: https://enrichlayer.com/docs/cli/configuration

Use this command to find the directory where CLI configuration files are stored.

```bash
el config path
```

--------------------------------

### Find Person by Role at Company

Source: https://enrichlayer.com/docs/cli/commands

Finds individuals holding a specific role within a named company. The --enrich flag can be used to get the full profile.

```bash
el profile role --company Microsoft --role CEO
el profile role --company Google --role CTO --enrich
```

--------------------------------

### Whoami Command

Source: https://enrichlayer.com/docs/cli/commands

Use `el whoami` to display the currently authenticated account. The `--json` flag is available for script usage.

```bash
el whoami
el whoami --json
```

--------------------------------

### Set Request Timeout with AbortController

Source: https://enrichlayer.com/docs/knowledge-base/troubleshooting/slow-responses

Implement a timeout for your HTTP client to prevent excessively long requests. This example uses AbortController to cancel a fetch request after 30 seconds, suitable for enrichment calls.

```javascript
const controller = new AbortController();
setTimeout(() => controller.abort(), 30000);

const response = await fetch(url, {
  headers: { Authorization: `Bearer ${API_KEY}` },
  signal: controller.signal
});
```

--------------------------------

### Batch Profile Lookup from Stdin

Source: https://enrichlayer.com/docs/cli/commands

Process a batch of URLs piped from standard input for profile lookups, outputting results in JSON Lines format.

```bash
cat urls.txt | el profile --stdin --jsonl
```

--------------------------------

### Read a single CLI setting

Source: https://enrichlayer.com/docs/cli/configuration

Use this command to retrieve the value of a specific CLI configuration setting.

```bash
el config get <key>
```

--------------------------------

### Find LinkedIn Profile from Phone Number

Source: https://enrichlayer.com/docs/cli/commands

The `el contact reverse-phone` command allows you to find a LinkedIn profile by providing a phone number. Use the `--enrich` flag to get additional details.

```bash
el contact reverse-phone +14155551234
el contact reverse-phone +14155551234 --enrich
```

--------------------------------

### Lookup Profile by URL

Source: https://enrichlayer.com/docs/cli/commands

Retrieve profile information for a given URL.

```bash
el profile <url>
```

--------------------------------

### Get Work Email from LinkedIn Profile URL

Source: https://enrichlayer.com/docs/cli/commands

The `el contact work-email` command retrieves the work email associated with a given LinkedIn profile URL. An optional `--json` flag can be used to format the output.

```bash
el contact work-email https://linkedin.com/in/satyanadella
el contact work-email https://linkedin.com/in/satyanadella --json
```

--------------------------------

### Batch Profile Lookup

Source: https://enrichlayer.com/docs/cli/commands

Process a batch of URLs from a file for profile lookups and output results in JSON Lines format.

```bash
el profile --file urls.txt --jsonl > profiles.jsonl
```

--------------------------------

### Authenticate with Enrich Layer CLI

Source: https://enrichlayer.com/docs/cli

Authenticate the Enrich Layer CLI by running the 'el login' command, which opens a browser for authentication. Alternatively, set the ENRICHLAYER_API_KEY environment variable.

```bash
el login
```

```bash
export ENRICHLAYER_API_KEY=your_key_here
```

--------------------------------

### Generate Shell Completion Scripts

Source: https://enrichlayer.com/docs/cli/commands

Generate shell completion scripts for Bash, Zsh, and Fish to improve command-line usability. Use `eval` to activate completions for the current session.

```bash
eval "$(el completion bash)"              # Bash
eval "$(el completion zsh)"               # Zsh
el completion fish > ~/.config/fish/completions/el.fish
```

--------------------------------

### Find Person by Name and Company

Source: https://enrichlayer.com/docs/cli

Find a person's profile by specifying their name and company domain.

```bash
# Find a person by name and company
el profile lookup --name "Satya Nadella" --company microsoft.com
```

--------------------------------

### Lookup School Data

Source: https://enrichlayer.com/docs/cli/commands

Retrieve school-related information for a given URL.

```bash
el school <url>
```

--------------------------------

### Check Credit Balance

Source: https://enrichlayer.com/docs/cli

Check the remaining credit balance for your Enrich Layer account.

```bash
# Check your credit balance
el credits
```

--------------------------------

### Configure Enrich Layer CLI

Source: https://enrichlayer.com/docs/cli/commands

Access commands for configuring the Enrich Layer CLI settings.

```bash
el config
```

--------------------------------

### Generate Shell Completions

Source: https://enrichlayer.com/docs/cli/commands

Generate shell completion scripts for various shells.

```bash
el completion <shell>
```

--------------------------------

### Check Credit Balance

Source: https://enrichlayer.com/docs/cli/commands

Check your current credit balance. Use the --table flag for a formatted table view.

```bash
el credits
```

```bash
el credits --table
```

--------------------------------

### Lookup Company by URL

Source: https://enrichlayer.com/docs/cli/commands

Retrieve company information for a given URL.

```bash
el company <url>
```

--------------------------------

### Lookup Profile by Name and Company

Source: https://enrichlayer.com/docs/cli/commands

Finds a person's profile by their name and company domain. Use the --enrich flag to retrieve the full profile details.

```bash
el profile lookup --name "Satya Nadella" --company microsoft.com
el profile lookup --first-name Satya --last-name Nadella --company microsoft.com
el profile lookup --name "Bill Gates" --company microsoft.com --enrich
```

--------------------------------

### Use Cache for Cost Savings

Source: https://enrichlayer.com/docs/cli/commands

Pass `--use-cache <mode>` to profile or company commands to reduce credit costs on repeated lookups. The flag is forwarded to the API as `use_cache` and is safe to enable even if not supported by the server.

```bash
el profile https://linkedin.com/in/satyanadella --use-cache if-present
el company https://linkedin.com/company/microsoft --use-cache if-recent
el profile --file urls.txt --jsonl --use-cache if-present > cached.jsonl
```

--------------------------------

### Authenticate with Enrich Layer CLI (Environment Variable)

Source: https://enrichlayer.com/docs/cli/getting-started

For CI/CD or scripted use, set the ENRICHLAYER_API_KEY environment variable with your API key.

```bash
export ENRICHLAYER_API_KEY=your_key_here
```

--------------------------------

### Batch Company Lookup

Source: https://enrichlayer.com/docs/cli/commands

Process a batch of company URLs from a file, outputting results in JSON Lines format to a specified output file.

```bash
el company --file companies.txt --jsonl --output companies.jsonl
```

--------------------------------

### Authenticate API Request with Python

Source: https://enrichlayer.com/docs/guides/authentication

This Python script demonstrates how to authenticate API requests using the requests library by passing your API key in the Authorization header.

```python
import requests

api_key = 'YOUR_API_KEY'
headers = {'Authorization': 'Bearer ' + api_key}
api_endpoint = 'https://enrichlayer.com/api/v2/profile'
profile_url = 'https://www.linkedin.com/in/williamhgates'
response = requests.get(api_endpoint,
                        params={'profile_url': profile_url},
                        headers=headers)
```

--------------------------------

### Lookup Job Data

Source: https://enrichlayer.com/docs/cli/commands

Retrieve job-related information for a given URL.

```bash
el job <url>
```

--------------------------------

### Control Output Formats

Source: https://enrichlayer.com/docs/cli/commands

Specify output formats using flags like `--format`, `--fields`, and `-o` for file output. The CLI automatically switches to JSON when output is piped to another command.

```bash
el profile https://linkedin.com/in/satyanadella --fields full_name,headline,city
el profile https://linkedin.com/in/satyanadella --format yaml
el search person --company Google --title Engineer --format csv -o engineers.csv
```

--------------------------------

### Retrieve Next Page of Search Results

Source: https://enrichlayer.com/docs/knowledge-base/api-usage/pagination-and-search

Pass the 'next_page' URL obtained from a previous response to fetch the subsequent set of results. This is crucial for iterating through large datasets.

```bash
curl -G \
  -H "Authorization: Bearer YOUR_API_KEY" \
  'https://enrichlayer.com/api/v2/search/person?country=US&page_size=10&next_token=30U9cV4q1Nz...truncated'
```

--------------------------------

### Logout Command

Source: https://enrichlayer.com/docs/cli/commands

Use `el logout` to remove stored credentials. The `--json` flag provides machine-readable output.

```bash
el logout
el logout --json
```

--------------------------------

### Find Personal Email by Name and Domain

Source: https://enrichlayer.com/docs/cli/commands

Use `el contact email` to find a personal email address. You must provide the company domain and either the full name or first and last names of the individual.

```bash
el contact email --name "Satya Nadella" --domain microsoft.com
el contact email --first-name Satya --last-name Nadella --domain microsoft.com
```

--------------------------------

### Enable Zsh shell completion

Source: https://enrichlayer.com/docs/cli/configuration

Add this command to your ~/.zshrc file to enable tab completion for Enrich Layer CLI commands in Zsh.

```bash
echo 'eval "$(el completion zsh)"' >> ~/.zshrc
source ~/.zshrc
```

--------------------------------

### API Request using Python

Source: https://enrichlayer.com/docs/guides/e164-phone-format

Shows how to perform a Reverse Contact Number Lookup using the Python requests library, including setting the Authorization header and passing the phone number in E.164 format.

```python
import requests

api_key = 'YOUR_API_KEY'
headers = {'Authorization': 'Bearer ' + api_key}
response = requests.get(
    'https://enrichlayer.com/api/v2/reverse_contact_number',
    params={'phone_number': '+14155552671'},
    headers=headers,
)
```

--------------------------------

### Autocomplete API Endpoint

Source: https://enrichlayer.com/docs/api-v3/autocomplete-api

Searches for companies by name and returns a list of up to 10 companies sorted by employee count in descending order. Includes company name, logo URL, domain details, industry, employee count, and location.

```APIDOC
## GET /api/v3/company/search?q={query}

### Description
Searches for companies by name and returns a list of up to 10 companies sorted by employee count in descending order. Includes company name, logo URL, domain details, industry, employee count, and location.

### Method
GET

### Endpoint
/api/v3/company/search?q={query}

### Parameters
#### Query Parameters
- **q** (string) - Required - Company name or partial name to search for

### Response
#### Success Response (200)
Returns an array of up to 10 companies sorted by employee count (descending).
- **companyName** (string) - The name of the company.
- **logoUrl** (string) - The URL of the company's logo. May be null.
- **domain** (object) - An object describing the company's web domain.
  - **domain.resolved** (string) - The registrable domain, normalized from any subdomain. Null if unknown.
  - **domain.original** (string) - The raw domain the match was found on, which may be a subdomain. Null if unknown.
  - **domain.alternatives** (array) - An array of additional known domains for the company.
- **industry** (string) - The industry the company operates in.
- **employeeCount** (integer) - The number of employees at the company.
- **location** (object) - An object containing location details. May be null.
  - **location.city** (string) - The city where the company is located.
  - **location.state** (string) - The state where the company is located.
  - **location.country** (string) - The country where the company is located.
- **linkedinUrl** (string) - The LinkedIn profile URL for the company.

#### Response Example
```json
[
  {
    "companyName": "Stripe",
    "logoUrl": "https://assets.enrichlayer.com/pp/profilepic/84bd39cc2914d1e0d12f781dba4b888f",
    "domain": {
      "resolved": "stripe.com",
      "original": "stripe.com",
      "alternatives": []
    },
    "industry": "Technology, Information and Internet",
    "employeeCount": 14492,
    "location": {
      "city": "South San Francisco",
      "state": "California",
      "country": "US"
    },
    "linkedinUrl": "https://www.linkedin.com/company/stripe"
  }
]
```

### Errors
Status| When  
---|---
400| `q` parameter is missing or empty  
429| Rate limit exceeded
```

--------------------------------

### Enable Bash shell completion

Source: https://enrichlayer.com/docs/cli/configuration

Add this command to your ~/.bashrc file to enable tab completion for Enrich Layer CLI commands in Bash.

```bash
echo 'eval "$(el completion bash)"' >> ~/.bashrc
source ~/.bashrc
```

--------------------------------

### Handle API Errors in JavaScript

Source: https://enrichlayer.com/docs/knowledge-base/api-usage/handling-errors

This function demonstrates how to handle common API errors like 404 (Not Found) and 429 (Rate Limited) when fetching profile data. It retries on rate limiting and returns null for not found profiles.

```javascript
async function enrichProfile(url) {
  const response = await fetch(
    `https://enrichlayer.com/api/v2/profile?profile_url=${encodeURIComponent(url)}`,
    { headers: { Authorization: `Bearer ${API_KEY}` } }
  );

  if (response.status === 404) {
    return null; // Profile not found — expected for some lookups
  }

  if (response.status === 429) {
    // Rate limited — wait and retry
    const retryAfter = response.headers.get('Retry-After') || '60';
    await new Promise(r => setTimeout(r, parseInt(retryAfter) * 1000));
    return enrichProfile(url); // Retry
  }

  if (!response.ok) {
    throw new Error(`API error: ${response.status}`);
  }

  return response.json();
}
```
Tokens:
Raw