> ## 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.
> Creates a People Database saved search for your team.
# Create Saved Search
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.
;
};
`name`, `filters` and `mode` are all required. The name must be unique within your team — a duplicate answers `409`.
Pick your filters from [Get Database Filters](/api-reference/endpoints/people-database/get-database-filters) called with `usage=ui`: filters that are not usable in the People Database UI answer `400` with the code `FILTER_UNAVAILABLE_FOR_USAGE`. Filters incompatible with the `mode` or with your team's plan are dropped silently.
The response contains only the created id. The stored `name` and `filters` are sanitized and plan-gated server-side — call [Get saved search](/api-reference/endpoints/people-database/get-saved-search) to read the stored saved search.
## OpenAPI
````yaml post /database/saved-searches
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/saved-searches:
post:
tags:
- People Database
summary: Create Saved Search
description: >-
Creates a People Database saved search for your team. It shows up in the
"Saved searches" menu of the People Database.
Filters come from [Get Database
Filters](/api-reference/endpoints/people-database/get-database-filters)
called with `usage=ui`: a filter not usable in the People Database UI is
refused with `FILTER_UNAVAILABLE_FOR_USAGE`, and the error message names
the refused filters, comma-separated. Filters incompatible with the
`mode` or with your team's plan are dropped silently; if none remain,
the request answers `400`.
Only the created id is returned. The stored `name` and `filters` are
sanitized and plan-gated server-side, so echoing the request payload
back would misreport what was persisted; call [Get Saved
Search](/api-reference/endpoints/people-database/get-saved-search) to
read the stored saved search.
operationId: createSavedSearch
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
- filters
- mode
properties:
name:
type: string
minLength: 1
maxLength: 200
description: >-
Display name, 1 to 200 characters after trimming. Unique
within your team.
example: Paris SaaS founders
filters:
type: array
minItems: 1
maxItems: 10
description: >-
People Database filters of the saved search. 1 to 10 filters
of shape `{ filterId, in?, out?, exactMatch? }` (no other
key: an unknown key such as `type` answers
`API_INVALID_FILTERS`), at most 1000 values per `in` / `out`
and 1000 characters per value.
items:
$ref: '#/components/schemas/PersonaFilter'
mode:
type: string
description: Search mode the filters target
enum:
- leads
- companies
example: leads
example:
name: Paris SaaS founders
mode: leads
filters:
- filterId: currentTitle
in:
- Founder
out: []
- filterId: country
in:
- France
out: []
responses:
'201':
description: Saved search created
content:
application/json:
schema:
$ref: '#/components/schemas/SavedSearchCreateResponse'
example:
data:
_id: lss_ExAmPlE4f7Kq2Wz9x
'400':
description: >-
Validation error. Possible codes: `API_INVALID_PARAMS`,
`API_INVALID_NAME`, `API_INVALID_FILTERS`, `API_INVALID_MODE`,
`SEARCH_FILTERS_MISSING`, `SEARCH_FILTERS_EMPTY`,
`SEARCH_FILTERS_INVALID`, `SEARCH_FILTERS_INPUT_TOO_LONG`,
`SEARCH_FILTERS_INPUT_TOO_MANY_VALUES`,
`FILTER_UNAVAILABLE_FOR_USAGE`
content:
application/json:
schema:
$ref: '#/components/schemas/PersonaError'
examples:
invalidName:
value:
error: Parameter name is invalid
code: API_INVALID_NAME
invalidFilters:
value:
error: Parameter filters is invalid
code: API_INVALID_FILTERS
invalidMode:
value:
error: Parameter mode is invalid
code: API_INVALID_MODE
emptyFilter:
value:
error: One of your filter is empty
code: SEARCH_FILTERS_EMPTY
tooManyValues:
value:
error: One of your filter has too many values
code: SEARCH_FILTERS_INPUT_TOO_MANY_VALUES
noValidFilter:
value:
error: You have no valid filters with the current search mode
code: SEARCH_FILTERS_INVALID
filterUnavailable:
value:
error: >-
The "companiesByIds" filter is not available for this type
of search
code: FILTER_UNAVAILABLE_FOR_USAGE
'401':
description: >-
Unauthorized - invalid or missing API key. An API key with no user
attached answers `{ "error": "Route unauthorized", "code":
"ROUTE_UNAUTHORIZED" }` in JSON instead.
content:
text/plain:
example: The authentication you supplied is incorrect
'405':
description: Method not allowed
content:
application/json:
schema:
$ref: '#/components/schemas/PersonaError'
example:
error: Route bad method
code: ROUTE_BAD_METHOD
'409':
description: A saved search with this name already exists for your team
content:
application/json:
schema:
$ref: '#/components/schemas/PersonaError'
example:
error: A search with this name already exists
code: SEARCH_NAME_ALREADY_EXISTS
'500':
description: The saved search could not be stored
content:
application/json:
schema:
$ref: '#/components/schemas/PersonaError'
example:
error: We could not save your search
code: SEARCH_INSERT_FAILED
components:
schemas:
PersonaFilter:
type: object
description: >-
One People Database filter, as stored in a persona or a saved search.
`in` includes matching values, `out` excludes them. There is no `type`
property: it is derived from `filterId` server-side.
required:
- filterId
properties:
filterId:
type: string
description: >-
People Database filter identifier. Use [Get Database
Filters](/api-reference/endpoints/people-database/get-database-filters)
to discover the valid ids.
example: currentTitle
in:
type: array
description: Values to include
items:
type: string
example:
- Founder
out:
type: array
description: Values to exclude
items:
type: string
example: []
exactMatch:
type: boolean
description: Exact-match toggle, for the text filters that support it
SavedSearchCreateResponse:
type: object
properties:
data:
type: object
properties:
_id:
type: string
description: Id of the created saved search
example: lss_ExAmPlE4f7Kq2Wz9x
PersonaError:
type: object
description: >-
Error envelope returned by the persona, saved-search and Get Database
Filters endpoints.
properties:
error:
type: string
description: Human-readable explanation of the failure
code:
type: string
description: Machine-readable error code, stable across releases
securitySchemes:
basicAuth:
type: http
scheme: basic
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.