> ## 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 Team Sender Exclusions

> Returns the senders that the dynamic sender strategies of the team cannot select.

> [!NOTE]
>
> This endpoint requires at least the **Email Pro** plan.

A campaign with a dynamic sender strategy (`contactOwner`, `leadImporter` or
`customField:<fieldName>`) takes the sender of each lead from the lead data.
The exclusion list removes senders, or some of their channels, from the senders
that the leads can select.

The team list applies to each dynamic campaign without a list of its own. To
read the list in force on one campaign, use
[Get Campaign Sender Exclusions](https://developer.lemlist.com/api-reference/endpoints/senders/get-campaign-sender-exclusions.md).

* An entry without `channels` excludes the sender on every channel, also on the
  accounts that they connect later.
* A user who left the team and a deleted account do not show.
* A team without a list returns `{ "data": { "senders": [] } }`.

> [!WARNING]
>
> These endpoints need an API key linked to a user. A key not linked to a user
> gets a `401`.


## OpenAPI

````yaml get /team/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:
  /team/dynamic-sender-exclusions:
    get:
      tags:
        - Senders
      summary: Get Team Sender Exclusions
      description: >-
        Returns the team exclusion list of the dynamic sender strategies.
        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/TeamDynamicSenderExclusions'
              example:
                data:
                  senders:
                    - userId: usr_T2wWj3GOt0hXms721
                      channels:
                        - type: email
                          id: usm_oZOkr8H1oFjgvDI6J
                        - type: linkedin
                    - userId: usr_ll2LqAVvLk75ER9fv
        '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
        '405':
          description: Method not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DynamicSenderExclusionError'
              example:
                error: Route bad method
                code: ROUTE_BAD_METHOD
components:
  schemas:
    TeamDynamicSenderExclusions:
      type: object
      description: >-
        The team exclusion list. Each campaign with a dynamic sender strategy
        and no list of its own uses it.
      required:
        - senders
      properties:
        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.