> ## Documentation Index
> Fetch the complete documentation index at: https://lemlist-docs-watch-list-public-api.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> Lists, per signal type, the filters you can set on a Signal Agent.

# List allowed filters per signal type

<Note>
  Each filter descriptor tells you the sides it supports (`in` to include, `out` to exclude), which sides are required, and any numeric bounds. Pass `type` to scope the response to a single signal type.
</Note>


## OpenAPI

````yaml get /watchlist/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: []
paths:
  /watchlist/filters:
    get:
      tags:
        - Signal Agents
      summary: List allowed filters per signal type
      parameters:
        - name: type
          in: query
          required: false
          description: >-
            Restrict the response to a single signal type. Omit to return
            filters for every type.
          schema:
            type: string
            enum:
              - companyIsHiring
              - companyRaisedFunds
              - recruitmentCampaign
              - jobChange
              - newHire
              - companyEmployeeVisitedMyWebsite
              - customSignals
              - competitorConnections
              - competitorReactions
              - companyFollowers
              - technologyChange
              - linkedinPeopleProfile
              - linkedinCompanyProfile
              - mergersAcquisitions
              - promotion
              - linkedinKeywords
              - externalSignalContact
              - externalSignalCompany
              - buyingIntent
          example: companyIsHiring
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WatchListApiFiltersResponse'
        '400':
          description: Validation error - invalid type
          content:
            text/plain:
              example: Invalid type values
        '401':
          description: Unauthorized - invalid or missing API key
          content:
            text/plain:
              example: Unauthorized
        '500':
          description: Internal server error
          content:
            text/plain:
              example: Internal server error
components:
  schemas:
    WatchListApiFiltersResponse:
      type: object
      properties:
        data:
          type: object
          description: Allowed filters keyed by signal type
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/WatchListFilterDescriptor'
    WatchListFilterDescriptor:
      type: object
      description: Describes a filter that can be set on a Signal Agent of a given type.
      properties:
        filterId:
          type: string
          description: Filter identifier
        name:
          type: string
          description: Human-readable filter name
        properties:
          type: array
          description: Filter sides supported by this filter
          items:
            type: string
            enum:
              - in
              - out
        required:
          type: array
          description: Filter sides that must be non-empty
          items:
            type: string
            enum:
              - in
              - out
        default:
          description: Default value, when the filter has one
        min:
          type: number
          description: Minimum value (numeric filters)
        max:
          type: number
          description: Maximum value (numeric filters)
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````