> ## 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. > Searches your connected CRM for contacts and links each one to the CRM record found, without creating any CRM record. # Search & Connect Contacts in the CRM Searches your connected CRM for each contact and links it to the CRM record found — the **Search & connect** action of the Contacts page. No CRM record is ever created: use `POST /contacts/crm/create` for that. Each contact it links then syncs its mapped fields with that CRM record, which can update it. Target the contacts with `idsOrEmails` (lemlist ids or email addresses) **or** with `listId` for a whole contact list, static or dynamic: 10,000 contacts at most either way. ## Asynchronous: read the outcome later The call queues the work and answers at once with what was **queued**, not with what the CRM returned. Each contact's outcome lands on its `crmSync` block shortly after: * `GET /contacts?idsOrEmails=...` returns each contact with its `crmSync` block (`searching`, `crmRecordId`, `notFoundAt`, `errors`), 100 contacts per call. * `GET /contacts?listId=...&crmSyncStatus=` lists the contacts of a list by state: `searching` while the search runs, then `synced` (linked), or `not_found` (no CRM record matched). Without `listId`, the filter reads every contact of the team: do not poll it. ## What the counts mean * `alreadyLinked`: already linked to a CRM record, synced with it again instead of searched. * `toSearch`: searched in the CRM, then linked or flagged `not_found`. * `notSearchable`: nothing the CRM can be searched with (no email address or LinkedIn URL), left untouched. * `alreadyInProgress`: a CRM search was already queued for them, not queued twice. * `notFound`: the references sent that match no contact of your team. ## OpenAPI ````yaml post /contacts/crm/search-and-connect 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: /contacts/crm/search-and-connect: post: tags: - Contacts summary: Search & Connect Contacts in the CRM description: >- Searches your connected CRM for each contact and links it to the CRM record found — the **Search & connect** action of the Contacts page. No CRM record is ever created: use `POST /contacts/crm/create` for that. Each contact it links then syncs its mapped fields with that CRM record, which can update it. Target the contacts with `idsOrEmails` (lemlist ids or email addresses) **or** with `listId` for a whole contact list: 10,000 contacts at most either way. **Asynchronous:** the call queues the work and answers at once with what was queued, not with what the CRM returned. Each contact's outcome lands on its `crmSync` block shortly after: read it with `GET /contacts?idsOrEmails=...` (100 per call), or, after a list, list its contacts by state with `listId` and `crmSyncStatus`: `searching` while the search runs, then `synced` once linked, or `not_found` when no CRM record matched. Without `listId`, `crmSyncStatus` reads every contact of the team: do not poll it. - A contact already linked to a CRM record is synced with it again (`alreadyLinked`). - A contact with nothing to search the CRM with is left untouched (`notSearchable`). - A contact whose CRM search is already queued is not queued twice (`alreadyInProgress`). Requires a connected CRM (HubSpot, Salesforce, Pipedrive, Attio or Zoho). requestBody: required: true content: application/json: schema: type: object properties: idsOrEmails: type: array items: type: string minItems: 1 maxItems: 10000 description: >- lemlist contact ids (`ctc_xxx`) or email addresses, 10,000 at most. Send either `idsOrEmails` or `listId`. example: - ctc_xW8Ou6C03Csv8vatp - john.doe@acme.com listId: type: string description: >- A contact list id (`clt_xxx`): acts on every contact of the list, static or dynamic, 10,000 at most. Use it instead of `idsOrEmails`. example: clt_Ab12Cd34Ef56Gh78I responses: '200': description: >- Queued — **not done yet.** The counts say what was queued; each record's outcome lands on its `crmSync` block shortly after. content: application/json: schema: type: object properties: success: type: boolean data: type: object properties: alreadyLinked: type: integer description: >- Contacts already linked to a CRM record: synced with it again instead of searched. toSearch: type: integer description: >- Contacts searched in the CRM: linked to the record found, flagged `not_found` otherwise. notSearchable: type: integer description: >- Records with nothing the CRM can be searched with: no email address or LinkedIn URL for a contact, no domain or LinkedIn URL for a company (Pipedrive also searches by name). Left untouched. alreadyInProgress: type: integer description: >- Contacts whose CRM search was already queued: not queued twice. notFound: type: array items: type: string description: >- The references sent that match no contact of your team, as sent. Always empty with `listId`. required: - alreadyLinked - toSearch - notSearchable - alreadyInProgress - notFound required: - success - data example: success: true data: alreadyLinked: 2 toSearch: 6 notSearchable: 1 alreadyInProgress: 0 notFound: - jane.doe@acme.com '400': description: >- Invalid request. Possible error codes: `INVALID_SELECTION` (neither or both of `idsOrEmails` and `listId`, or an empty `idsOrEmails`), `TOO_MANY_RECORDS` (more than 10,000 references), `INVALID_LIST_ID` (not a `clt_xxx` id), `LIST_ENTITY_MISMATCH` (the list does not hold contacts), `LIST_TOO_LARGE` (the list holds more than 10,000 contacts), `NO_CRM_CONNECTED` (no CRM connected to the team), `VALIDATION_ERROR` (a field of the wrong type). content: application/json: example: success: false error: code: NO_CRM_CONNECTED message: No CRM connected for this team '401': description: The authentication you supplied is incorrect. content: text/plain: example: The authentication you supplied is incorrect '404': description: The team has no list with this `listId` (`LIST_NOT_FOUND`). content: application/json: example: success: false error: code: LIST_NOT_FOUND message: List not found components: securitySchemes: basicAuth: type: http scheme: basic ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.