> ## 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 available filters for searching the people and companies database. # Get Database Filters 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. ; }; Please, note that: * you will not be able to use a filter for a People database query if the leads keyword is not listed in the mode property * you will not be able to use a filter for a Companies database query if the companies keyword is not listed in the mode property * to build a [saved search](/api-reference/objects-definitions/saved-search), call this endpoint with `usage=ui`: saved searches refuse the filters that are not usable in the People Database UI ## OpenAPI ````yaml get /database/filters 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/filters: get: tags: - People Database summary: Get Database Filters parameters: - name: usage in: query required: false description: >- Context the filters will be used in. `api` (default) lists the filters accepted by the search endpoints. `ui` lists the filters usable in the People Database UI: use it to pick the filters of a [saved search](/api-reference/objects-definitions/saved-search), which refuses the others. schema: type: string enum: - api - ui default: api example: ui - name: mode in: query required: false description: Restrict the list to the filters of one search mode schema: type: string enum: - leads - companies example: leads responses: '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/DatabaseFilter' example: - filterId: country description: >- Country: Filter by the lead's country of residence (e.g. 'United States', 'France'). Targets where the person lives, not where their employer is headquartered. mode: - leads type: autocomplete - filterId: department description: >- Department: Filter by the lead's department (e.g. 'Sales', 'Marketing', 'Engineering', 'Finance / Legal / Admin', 'Human Resources'). Use to target a functional buyer persona regardless of the exact job title. mode: - leads type: select values: - Sales - Customer service - Engineering - Marketing - Operations - Human Resources - Finance / Legal / Admin - Other '400': description: Validation error - invalid query parameters content: application/json: schema: $ref: '#/components/schemas/PersonaError' examples: invalidUsage: value: error: Parameter usage is invalid code: API_INVALID_USAGE invalidMode: value: error: Parameter mode is invalid code: API_INVALID_MODE '401': description: The authentication you supplied is incorrect 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 components: schemas: DatabaseFilter: type: object description: >- A filter usable in the People and Companies database searches, as listed by Get Database Filters. required: - filterId - description - type properties: filterId: type: string description: Filter identifier, to send as `filterId` in the search filters example: department description: type: string description: >- Human-readable filter name, followed by a description of what the filter matches when one exists example: >- Department: Filter by the lead's department (e.g. 'Sales', 'Marketing', 'Engineering', 'Finance / Legal / Admin', 'Human Resources'). Use to target a functional buyer persona regardless of the exact job title. mode: type: array description: >- Search modes the filter can be used in: `leads` for Search People Database, `companies` for Search Companies Database. Omitted when the request is scoped to a single `mode`. items: type: string enum: - leads - companies example: - leads type: type: string description: >- Kind of input the filter expects. `level` is a two-level dropdown of the People Database UI; it is reported as `select` by default. enum: - text - select - autocomplete - static - slider - level - elasticId example: select values: type: array description: Allowed values, for the filters that have a fixed list items: type: string example: - Sales - Marketing - Engineering range: type: object description: Slider configuration, for the `slider` filters properties: min: type: number description: Lowest accepted value example: 0 max: type: number description: Highest accepted value example: 10000 default: type: string description: Default range, formatted `min|max` example: 1|10000 percentage: type: boolean description: Whether the values are percentages example: false 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.