> ## 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.
> Exports the companies matching a search as a CSV file.
# Export Companies database
This endpoint is rolling out progressively. If it returns a 403, ask support to enable it for your team.
Filter ids come from [GET Filters](/api-reference/endpoints/people-database/get-database-filters), called with `mode=companies`. That endpoint lists the allowed `values` for filters with a closed list; for `autocomplete` filters (companies, countries, technologies) there is no enumerable list — run a [search](/api-reference/endpoints/people-database/search-companies-database) to discover which values match.
This export is billed on your team's 24h search quota, one unit per 100 exported rows. Exporting the 1000-row maximum costs 10 searches.
## OpenAPI
````yaml get /database/companies/export
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:
/database/companies/export:
get:
tags:
- People Database
summary: Export Companies database search
description: >-
Exports the companies matching a search as a CSV file. The response is
streamed as `text/csv` with a `Content-Disposition: attachment` header.
The export is defined by the search itself — there is no hand-picked
selection: rows come back in the team's stable search order, capped by
`limit`.
**Billing** — charged on the team's existing 24h search quota, one unit
per 100 exported rows (an export of 1000 rows costs 10). Nothing is
charged if the export fails.
**Caps** — 1000 rows maximum; a higher `limit` is rejected with a 400.
Free-trial and freemium teams are capped lower, at one page (100 rows),
matching the search window their plan allows.
parameters:
- name: filters
in: query
required: true
description: >-
The search to export, URL-encoded JSON array — the same `filters`
array `POST /database/companies` takes. Each entry needs a
`filterId` and at least one `in`/`out` value.
Filter ids and their allowed values come from `GET
/database/filters?mode=companies`. That endpoint returns `values`
only for filters with a closed list; filters of type `autocomplete`
(companies, countries, technologies…) have no enumerable list, so
their values are discovered by running a search rather than read
upfront.
example: '[{"filterId":"currentCompanyCountry","in":["France"],"out":[]}]'
schema:
type: string
- name: limit
in: query
required: false
description: >-
How many rows to export. Defaults to 1000, which is also the
maximum.
schema:
type: integer
minimum: 1
maximum: 1000
default: 1000
responses:
'200':
description: CSV file download
content:
text/csv:
example: >-
Company name,LinkedIn URL,Industry,Website,Size,Employee
count,City,Country
Acme
Inc,https://www.linkedin.com/company/example-company,Software
Development,https://acme.com,11-50,42,Paris,France
'400':
description: >-
Invalid `filters` JSON, a filter unavailable for API usage, or a
`limit` above the cap
content:
application/json:
example:
error: A CSV export holds at most 1000 rows
'401':
description: Unauthorized
'403':
description: The team's 24h search quota does not cover this export
content:
application/json:
example:
error: >-
This export needs 10 searches from your 24h quota, and you
have 3 left.
components:
securitySchemes:
basicAuth:
type: http
scheme: basic
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.