> ## 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. # Get Campaign Sender Exclusions > Returns the senders that the leads of a campaign cannot select. > [!NOTE] > > This endpoint requires at least the **Email Pro** plan. Returns the list in force on the campaign: * `source: "campaign"`: the campaign has its own list, which replaces the team list. An empty list excludes nobody on this campaign. * `source: "team"`: the campaign uses the [team list](https://developer.lemlist.com/api-reference/endpoints/senders/get-team-sender-exclusions.md). The list applies only when `senderStrategy` is dynamic: `contactOwner`, `leadImporter` or `customField:`. On a `random` campaign, the [sender pool](https://developer.lemlist.com/api-reference/endpoints/senders/get-campaign-senders.md) applies. A campaign hidden from the user of the API key answers `404`. > [!WARNING] > > These endpoints need an API key linked to a user. A key not linked to a user > gets a `401`. ## OpenAPI ````yaml get /campaigns/{campaignId}/dynamic-sender-exclusions 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: /campaigns/{campaignId}/dynamic-sender-exclusions: parameters: - name: campaignId in: path required: true description: The unique identifier of the campaign example: cam_hNtZRPpyNP6HRp4PV schema: type: string get: tags: - Senders summary: Get Campaign Sender Exclusions description: >- Returns the exclusion list in force on a campaign: its own list, else the team list. Requires the Email Pro plan. parameters: [] responses: '200': description: Success headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/CampaignDynamicSenderExclusions' example: data: campaignId: cam_hNtZRPpyNP6HRp4PV senderStrategy: contactOwner source: campaign senders: - userId: usr_T2wWj3GOt0hXms721 channels: - type: email id: usm_oZOkr8H1oFjgvDI6J - type: linkedin - userId: usr_ll2LqAVvLk75ER9fv '400': description: The campaign ID is not valid content: application/json: schema: $ref: '#/components/schemas/DynamicSenderExclusionError' example: error: Wrong param campaign id code: WRONG_PARAM_CAMPAIGN_ID '401': description: >- The authentication you supplied is incorrect, or the API key is not linked to a user content: text/plain: example: The authentication you supplied is incorrect '402': description: The endpoint requires at least the Email Pro plan content: text/plain: example: route is available starting emailPro plan '404': description: Campaign not found, or hidden from the user of the API key content: application/json: schema: $ref: '#/components/schemas/DynamicSenderExclusionError' example: error: Campaign not found code: CAMPAIGN_DYNAMIC_SENDER_CAMPAIGN_NOT_FOUND '405': description: Method not allowed content: application/json: schema: $ref: '#/components/schemas/DynamicSenderExclusionError' example: error: Route bad method code: ROUTE_BAD_METHOD components: schemas: CampaignDynamicSenderExclusions: type: object description: The exclusion list in force on a campaign. required: - campaignId - senderStrategy - source - senders properties: campaignId: type: string description: The campaign ID. senderStrategy: type: string description: >- The sender strategy of the campaign. The list applies only to a dynamic strategy: `contactOwner`, `leadImporter` or `customField:`. source: type: string enum: - campaign - team description: >- `campaign`: the campaign has its own list. `team`: the campaign uses the team list. senders: type: array description: >- The excluded senders. A user who left the team or a deleted account does not show. items: $ref: '#/components/schemas/DynamicSenderExclusion' DynamicSenderExclusionError: type: object description: Error of the dynamic sender exclusion endpoints. required: - error - code properties: error: type: string description: Human-readable error message. code: type: string description: Machine-readable error code. DynamicSenderExclusion: type: object description: One excluded sender. required: - userId additionalProperties: false properties: userId: type: string description: A team member. channels: type: array minItems: 1 description: >- The channels to exclude. Without `channels`, the sender is excluded on every channel, also on the accounts that they connect later. items: $ref: '#/components/schemas/DynamicSenderExclusionChannel' DynamicSenderExclusionChannel: type: object description: One channel to exclude. required: - type additionalProperties: false properties: type: type: string enum: - email - whatsapp - phone - linkedin - other description: >- The channel type. `linkedin` is the LinkedIn profile. `other` is the manual tasks, the API calls and the steps without an account. id: type: string description: >- The account: the mailbox ID for `email`, the WhatsApp account ID for `whatsapp`, the phone number for `phone`, as [List Senders](/api-reference/endpoints/senders/list-senders) returns them. Required for these 3 types. Not allowed for `linkedin` and `other`. securitySchemes: basicAuth: type: http scheme: basic ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.