> ## Documentation Index
> Fetch the complete documentation index at: https://developer.lemlist.com/llms.txt
> Use this file to discover all available pages before exploring further.
> Retrieves companies from your CRM. Use `idsOrDomains` to fetch specific companies by ID or domain in a single request (max 100), `crmIds` to find them from their record id in your connected CRM, or omit them to get a paginated list of all companies.
# Get Many Companies
export const SnippetObjectReference = ({objectName, objectPath = null}) => {
const lowerCaseObjectName = objectName.toLowerCase();
if (lowerCaseObjectName === 'lead' || lowerCaseObjectName === 'leads') {
return
This endpoint uses the {objectName} object. Make sure to also check the {lowerCaseObjectName === 'lead' ? 'Contact' : 'Lead'} object to understand the distinction between the two.
;
}
return
This endpoint uses the {objectName} object.
;
};
## Finding a company from your CRM
Use `crmIds` (up to 100, comma-separated) with the record ids of your connected CRM, for example `GET /companies?crmIds=123456789` with a HubSpot company id; for Salesforce, pass the 18-character Account id. The answer is the same as with `idsOrDomains`: the companies found in `data`, each with the matched id under `crmSync.crmRecordId`; ids that match nothing are skipped.
`idsOrDomains` takes precedence over `crmIds`; a lookup ignores the list filters and the pagination.
## OpenAPI
````yaml get /companies
openapi: 3.0.0
info:
title: lemlist API
version: 1.0.0
description: >-
Welcome to the lemlist Developer Documentation.
lemlist is very customizable and open. You'll find on this page all the API
and integration you can do with lemlist.
# Rate Limit
lemlist's API rate limits requests in order to prevent abuse and overload of
our services.
Rate limits are applied on all routes and per API key performing the
request.
The rate limits are **20** requests per **2** seconds.
The response provides any information you may need about it:
| Header | Description |
| --- | --- |
| Retry-After | The number of seconds in which you can retry |
| X-RateLimit-Limit | The maximum requests in that time |
| X-RateLimit-Remaining | The number of remaining requests you can make |
| X-RateLimit-Reset | The date when the rate limit will reset |
_Example of values for the rate limit headers_
``` json
{
"Retry-After": 2,
"X-RateLimit-Limit": 20,
"X-RateLimit-Remaining": 7,
"X-RateLimit-Reset" : "Tue Feb 16 2021 09:02:42 GMT+0100 (Central European Standard Time)"
}
```
# Definitions
## Team
A team is the entity of lemlist that can handle users and billing.
## Credits
Credits are the coins a team uses to enrich emails, LinkedIn URLs, etc. via
the enrich route. Each enrichment feature needs a certain amount of credits
to run.
## User
You use a user account to connect to lemlist and send messages via the
connected emails or LinkedIn account.
## Campaign
A campaign is the entity to automate outreach. A campaign has multiple
sequences composed of steps.
## Lead
A lead is a person that you try to contact via a campaign.
## Activity
An activity is the history of all the steps.
## Unsubscribe
An unsubscribe occurs when a person decides they don't want to receive
emails from you anymore.
# Authentication
All API routes use the dedicated subdomain `api.lemlist.com`.
lemlist uses API keys to allow access to the API. You can get your lemlist
API key at our [integration
page](https://app.lemlist.com/settings/integrations).
You need to add the `Authorization` header using the `Basic` authentication
type. `login:password` **where the login is always empty and the password is
the API key**.
⚠️ **Don't forget to add the semicolon (**`:`**) before your API key in curl
command.**
> To authorize, use this code:
``` shell
curl https://api.lemlist.com/api/team \
--user ":YourApiKey"
```
**Make sure to replace** **`YourApiKey`** **with your API key.**
# Give feedback
If you want to report a bug, ask for data, or share with us a use case,
please fill this [form](https://lemlist.typeform.com/to/mfVlkyGf). It will
help us centralize your needs!
servers:
- url: https://api.lemlist.com/api
security:
- basicAuth: []
tags:
- name: Enrichment Providers
description: >-
The data providers lemlist can call to find an email or a phone.
Internal providers are paid with lemlist credits and always available.
External providers run on your own account: connect one by saving its API
key, and it becomes available to your waterfalls. `GET
/enrichments/providers` is the catalog of provider ids accepted by the
waterfall endpoints.
- name: Enrichment Waterfalls
description: >-
Control which data providers lemlist calls when enriching a contact, and
in which order.
A waterfall is an ordered list of providers for one enrichment `type`
(`email` or `phone`). Providers are tried one after the other until one
returns a result.
Every team has exactly one default waterfall per type (`isDefault: true`).
While its `editor` is `lemlist` it follows the lemlist behaviour:
providers you connected with your own API key are tried first, then
internal providers in a random order. Once a team member edits its
provider list, `editor` becomes that user's id and the list is followed as
is; resetting it hands it back to `lemlist`.
Custom waterfalls (`isDefault: false`) carry `conditions` on the contact
being enriched, keyed by contact property; every key present must match.
When a contact is enriched, lemlist runs a single waterfall: the custom
waterfall of the requested type whose conditions match the contact, or the
default waterfall when none does. If several match, the one with the most
condition keys wins, then the most recently updated. Only that waterfall
runs; when it finds nothing, the enrichment ends without falling back to
another one.
paths:
/companies:
get:
tags:
- Companies
summary: Get Many Companies
description: >-
Retrieves companies by IDs/domains or by CRM record ids, or lists them
with filters.
When using `idsOrDomains`, returns the matching companies in `data`,
with `total` and no pagination.
When using `crmIds`, looks the companies up by their record id in the
connected CRM (HubSpot, Salesforce, or Pipedrive) and returns them like
`idsOrDomains` does, each with the matched id under
`crmSync.crmRecordId`.
Otherwise, returns a paginated response with `data`, `total`, `limit`,
and `offset`.
`idsOrDomains` takes precedence over `crmIds`; a lookup ignores the list
filters and the pagination.
parameters:
- name: idsOrDomains
in: query
required: false
description: >-
Comma-separated list of company IDs or domains to fetch. When
provided, returns only matching companies (no pagination). Each
value is classified as a company ID (e.g. `cpn_xxx`) or a domain
(e.g. `example.com`). URLs are normalized automatically (e.g.
`https://example.com/path` → `example.com`). Invalid values are
silently skipped. Maximum 100 values.
example: cpn_gG7PsmZFpEAnpMCHO,persana.ai
schema:
type: string
- name: crmIds
in: query
required: false
description: >-
Comma-separated record ids of companies in the CRM connected to the
team (HubSpot, Salesforce, or Pipedrive); for Salesforce, the
18-character Account id. Returns the companies found in `data`, with
`total` and no pagination, each with the matched id under
`crmSync.crmRecordId`; ids that match nothing are skipped, and
`data` is empty when no CRM is connected. Duplicates are removed; an
empty value is ignored. Maximum 100 values (`TOO_MANY_CRM_IDS`); a
value over 25 characters answers `INVALID_CRM_ID`. Ignored when
`idsOrDomains` is provided.
example: 123456789,987654321
schema:
type: string
style: form
explode: false
- name: offset
in: query
required: false
description: >-
Number of companies to skip for pagination. Defaults to 0. Ignored
when `idsOrDomains` is provided.
schema:
type: integer
minimum: 0
default: 0
- name: sortBy
in: query
required: false
description: >-
The field by which to sort. Currently, only 'createdAt' is
supported.
example: createdAt
schema:
type: string
enum:
- createdAt
- name: sortOrder
in: query
required: false
description: >-
The sort direction. Use 'desc' for descending order; any other value
(or omission) will sort in ascending order.
example: desc
schema:
type: string
enum:
- asc
- desc
- name: search
in: query
required: false
description: Search by company name (case insensitive)
example: lemlist
schema:
type: string
- name: fields
in: query
required: false
description: >-
Returns selected fields. Returns all fields if empty. Each field is
separated by a comma (e.g., '_id,fields.name,domain')
example: _id,fields.name,domain
schema:
type: string
- name: limit
in: query
required: false
description: 'Number of companies to retrieve. Default: 100. Maximum: 500'
example: '10'
schema:
type: integer
minimum: 1
maximum: 500
default: 100
- name: listId
in: query
required: false
description: >-
Filter companies to the members of a static CRM company list
(`clt_xxx` format). Combines with every other filter. Ignored when
`idsOrDomains` is provided.
example: clt_abc123def456ghi78
schema:
type: string
pattern: ^clt_[a-zA-Z0-9]+$
- name: crmSyncStatus
in: query
required: false
description: >-
Filter companies by their CRM sync state against the team's active
CRM provider. Requires a CRM (Hubspot, Salesforce, or Pipedrive) to
be connected — otherwise the request returns `400 NO_CRM_CONNECTED`.
Common values:
- `synced` — the company has a CRM record and no sync errors.
- `not_synced` — the company has no CRM record yet.
- `error` — at least one sync error is currently raised.
- A specific error reason (lowercase form), to filter by root cause:
`unique_index_error_company`, `property_doesnt_exist`,
`required_field_missing`, `company_already_exists_with_name`,
`company_already_exists_with_linkedin_url`.
For each returned company, see
`crmSync.errors[].metadata.alreadyExistingCompanyId` to identify the
lemlist company that already occupies the conflicting CRM record
(useful to remap contacts before deleting the duplicate).
example: unique_index_error_company
schema:
type: string
enum:
- synced
- not_synced
- error
- unique_index_error_company
- property_doesnt_exist
- required_field_missing
- company_already_exists_with_name
- company_already_exists_with_linkedin_url
- name: fieldRejectionReason
in: query
required: false
description: >-
Filter companies to those carrying a field rejection with this
reason — a value lemlist refused to write, raised during CRM sync
(`crm_sync_*`). Returns an empty list (`total: 0`) when no company
matches. Each returned company exposes the full detail under
`fieldRejections[]` (which field, why, and `conflictingRecordId` for
duplicates). Independent of `crmSyncStatus` (which keys off the live
provider errors); this filter reads the stored field rejections.
Only applies to the paginated list — ignored when `idsOrDomains` is
provided (that path returns the exact companies requested,
unfiltered).
example: crm_sync_duplicate_company
schema:
type: string
enum:
- crm_sync_duplicate_company
- crm_sync_duplicate_company_domain
- crm_sync_duplicate_company_name
- crm_sync_invalid_domain
- crm_sync_duplicate_linkedin_url
- crm_sync_duplicate_linkedin_url_sales_nav
- crm_sync_invalid_linkedin_url
- crm_sync_linkedin_url_not_company
- crm_sync_invalid_url
- crm_sync_value_oscillating
- enrichment_company_duplicate_core_signal_id
- enrichment_company_duplicate_domain
- enrichment_company_duplicate_linkedin_url
- enrichment_company_duplicate_linkedin_url_sales_nav
- enrichment_company_duplicate_name
- crm_sync_owner_sync_loop
- crm_sync_unmapped_user
- crm_sync_value_incompatible
- crm_sync_unknown_error
responses:
'200':
description: >-
Success. Returns an object with `data` and `total`; `limit` and
`offset` are only present on the paginated list, not with
`idsOrDomains` or `crmIds`.
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Company'
total:
type: integer
limit:
type: integer
description: Only on the paginated list.
offset:
type: integer
description: Only on the paginated list.
required:
- data
- total
example:
data:
- _id: cpn_gG7PsmZFpEAnpMCHO
createdAt: '2025-10-26T11:54:27.387Z'
createdBy: usr_iGBmhLaxZmL0s7k1G
domain: persana.ai
fields:
name: Persana AI
picture: https://example.com/logos/company-1.png
ownerId: usr_iGBmhLaxZmL0s7k1G
- _id: cpn_FEWCjzMWXo5StjpDa
createdAt: '2025-10-26T11:45:18.773Z'
createdBy: usr_iGBmhLaxZmL0s7k1G
domain: duno.ai
fields:
industry: IT Services and IT Consulting
name: Duno.ai
picture: https://example.com/logos/company-2.png
ownerId: usr_iGBmhLaxZmL0s7k1G
- _id: cpn_2STz8x5Bexmd0nvIz
createdAt: '2025-10-25T21:37:45.741Z'
createdBy: usr_iGBmhLaxZmL0s7k1G
domain: tally.so
fields:
industry: Computer Software
name: lemlist family
picture: https://example.com/logos/lemlist.png
ownerId: usr_iGBmhLaxZmL0s7k1G
- _id: cpn_Qf4CJuUrNUNmHm6uZ
createdAt: '2025-10-24T07:26:34.956Z'
createdBy: usr_ahfFktBBHUIxbVG5P
domain: example.com
fields:
name: Growth & GTM Engineering
ownerId: usr_ahfFktBBHUIxbVG5P
- _id: cpn_A1B2C3D4E5F6G7H8I
createdAt: '2025-11-02T09:14:08.512Z'
createdBy: usr_A1B2C3D4E5F6G7H8I
domain: acme.com
fields:
name: Acme Inc
ownerId: usr_A1B2C3D4E5F6G7H8I
crmSync:
provider: hubspot
crmRecordId: null
syncDisabled: false
errors:
- type: CONNECT_FAILED
reason: UNIQUE_INDEX_ERROR_COMPANY
raisedAt: '2025-11-02T09:14:12.034Z'
metadata:
alreadyExistingCompanyId: cpn_J1K2L3M4N5O6P7Q8R
total: 59310
limit: 100
offset: 0
'400':
description: >-
Either a plain `{ "error": "..." }` (`Bad team`, `limit` below 1),
or a validation envelope. Possible error codes: `INVALID_CRM_ID` (a
`crmIds` list with no usable value, or a value longer than 25
characters), `TOO_MANY_CRM_IDS` (more than 100 `crmIds` values),
`INVALID_IDS_OR_DOMAINS` (no valid id or domain in `idsOrDomains`),
`TOO_MANY_IDS_OR_DOMAINS` (more than 100 `idsOrDomains` values),
`CRM_LIST_ENTITY_MISMATCH` (the `listId` points at a contact list),
`CRM_LIST_DYNAMIC` (the list is filter-driven, so it has no stored
membership to filter on), `INVALID_CRM_SYNC_STATUS`,
`NO_CRM_CONNECTED` (`crmSyncStatus` without a connected CRM),
`INVALID_FIELD_REJECTION_REASON`.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ApiErrorMessage'
- $ref: '#/components/schemas/ApiErrorEnvelope'
examples:
bad-team:
value:
error: Bad team
limit-below-1:
value:
error: limit must be >= 1
invalid-crm-id:
value:
success: false
error:
code: INVALID_CRM_ID
message: Invalid crmId value
too-many-crm-ids:
value:
success: false
error:
code: TOO_MANY_CRM_IDS
message: crmIds exceeds the maximum of 100 values
no-crm-connected:
value:
success: false
error:
code: NO_CRM_CONNECTED
message: No CRM connected for this team
entity-mismatch:
value:
success: false
error:
code: CRM_LIST_ENTITY_MISMATCH
message: This list holds contacts, not companies
dynamic-list:
value:
success: false
error:
code: CRM_LIST_DYNAMIC
message: >-
This list is dynamic (filter-driven) and cannot be
searched by membership
'401':
description: The authentication you supplied is incorrect
content:
text/plain:
example: The authentication you supplied is incorrect
'404':
description: >-
No list on this team matches `listId` (`CRM_LIST_NOT_FOUND`). A list
of another team and a deleted list both answer this.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorEnvelope'
example:
success: false
error:
code: CRM_LIST_NOT_FOUND
message: No list found with this id
'405':
description: Method not allowed
components:
schemas:
Company:
type: object
description: An organization record in your CRM.
properties:
_id:
type: string
description: Unique company identifier
teamId:
type: string
description: >-
Team the company belongs to. Returned by `GET
/companies/{companyId}` and the `idsOrDomains` and `crmIds` lookups;
the paginated list returns it only when requested with `fields`.
domain:
type: string
description: Website domain
linkedinUrl:
type: string
description: >-
LinkedIn company page URL. Returned by `GET /companies/{companyId}`
and the `idsOrDomains` and `crmIds` lookups; the paginated list
returns it only when requested with `fields`.
linkedinUrlSalesNav:
type: string
description: >-
Sales Navigator company URL. Returned by `GET
/companies/{companyId}` and the `idsOrDomains` and `crmIds` lookups;
the paginated list returns it only when requested with `fields`.
fields:
type: object
description: >-
Key/value attributes of the company, standard and custom (e.g.,
name, picture, industry, location, size, foundedOn). These values
are always under `fields`, never at the top level of the object.
additionalProperties: true
createdBy:
type: string
description: User ID who created the company
ownerId:
type: string
description: User ID of the owner of the company
createdAt:
type: string
format: date-time
description: Creation timestamp
source:
type: string
description: >-
Origin of the company record, e.g. `api` when it was created through
this API. Returned by `GET /companies/{companyId}` and the
`idsOrDomains` and `crmIds` lookups, not by the paginated list.
fieldRejections:
type: array
description: >-
Values lemlist refused to write on this company, each with its
reason. Empty when none. Filter the list endpoint to only flagged
companies via `GET /companies?fieldRejectionReason=...`.
items:
$ref: '#/components/schemas/FieldRejection'
crmSync:
type: object
nullable: true
description: >-
CRM sync status for the company, resolved against the team's active
CRM provider (Hubspot, Salesforce, or Pipedrive). Only present when
a CRM is connected. Use this block to monitor sync state and resolve
duplicates (e.g. via `GET
/companies?crmSyncStatus=unique_index_error_company`).
properties:
provider:
type: string
enum:
- hubspot
- salesforce
- pipedrive
description: Active CRM provider for the team.
crmRecordId:
type: string
nullable: true
description: >-
Identifier of the company record on the CRM side. `null` when
the lemlist company has not been synced yet.
syncDisabled:
type: boolean
description: When `true`, automatic sync is paused for this company.
errors:
type: array
description: >-
List of recent sync errors. Empty when the company is synced
cleanly.
items:
type: object
properties:
type:
type: string
description: >-
Coarse error category (e.g. `CONNECT_FAILED`,
`CREATE_FAILED`, `UPDATE_FAILED`).
reason:
type: string
description: >-
Specific error reason. Matches the lowercase form accepted
by the `crmSyncStatus` query param (e.g.
`UNIQUE_INDEX_ERROR_COMPANY`, `PROPERTY_DOESNT_EXIST`,
`REQUIRED_FIELD_MISSING`).
raisedAt:
type: string
format: date-time
description: Timestamp when the error was last raised.
metadata:
type: object
additionalProperties: true
description: >-
Extra context. For `UNIQUE_INDEX_ERROR_COMPANY`, contains
`alreadyExistingCompanyId` — the lemlist company that
already occupies the conflicting CRM record. Use it to
remap contacts onto the right lemlist company before
deleting the duplicate.
ApiErrorMessage:
type: object
description: Error answered as a plain message by the contact and company endpoints.
properties:
error:
type: string
description: Human-readable explanation.
required:
- error
ApiErrorEnvelope:
type: object
description: Error envelope of the contact and company endpoints.
properties:
success:
type: boolean
example: false
error:
type: object
properties:
code:
type: string
description: Machine-readable error code, stable across releases.
message:
type: string
description: Human-readable explanation.
required:
- code
- message
required:
- success
- error
FieldRejection:
type: object
description: >-
A value lemlist refused to write on a Contact or Company, with the
reason why. Surfaced under `fieldRejections[]` on those objects; filter
a list endpoint to only flagged records via the `fieldRejectionReason`
query param.
properties:
field:
type: string
description: >-
The record field the rejected value targeted (e.g. `emails`,
`linkedinUrl`, `domain`).
reason:
type: string
description: >-
Why the value was rejected, prefixed by its origin — `enrichment_*`
(raised while enriching) or `crm_sync_*` (raised during CRM sync).
Same values accepted by the `fieldRejectionReason` query param.
source:
type: string
description: >-
Where the rejection came from — an enrichment source (`lemrich`) or
a CRM provider (`hubspot`, `salesforce`, `pipedrive`).
conflictingRecordId:
type: string
description: >-
The lemlist record that already holds the value, when the rejection
identifies one — use it to merge or remap before resolving the
duplicate. Always a lemlist id (`ctc_…` for a contact, `cpn_…` for a
company), never a CRM record id. Omitted otherwise.
rejectedValue:
type: string
description: The value that was refused.
rejectedAt:
type: string
format: date-time
description: When the rejection was recorded.
securitySchemes:
basicAuth:
type: http
scheme: basic
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.