> ## 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.

# Create View

> Creates a view on the Contacts, Companies or Tasks list and pins it on the API key user's tabs.

> [!NOTE]
>
> This endpoint uses the [View object](https://developer.lemlist.com/api-reference/objects-definitions/view.md).

> [!NOTE]
>
> Pick the conditions from [Get View Fields](https://developer.lemlist.com/api-reference/endpoints/views/get-view-fields.md). The response holds the view id and the `url` that opens the list on it.


## OpenAPI

````yaml post /views
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:
  /views:
    post:
      tags:
        - Views
      summary: Create View
      description: >-
        Creates a view on one list for the API key's user and pins it on their
        tabs.


        Each condition is checked against [Get View
        Fields](/api-reference/endpoints/views/get-view-fields): an unknown
        field, an operator the field does not offer or a value it does not
        accept answers `400` with `ENTITY_VIEW_INVALID_FILTER`, and the message
        names the field and what it takes. Without `filters`, the view shows
        every record.


        `visibility: "everyone"` shares the view with the team and needs the
        "Create views for the team" permission. A scope (the user's private
        views, the team's shared views) holds up to 200 views.


        The API does not set the sort or the columns: the view opens with the
        page's default sort and the user's columns, both editable in lemlist.
      operationId: createView
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
                - entity
                - name
              properties:
                entity:
                  $ref: '#/components/schemas/ViewEntity'
                name:
                  type: string
                  minLength: 1
                  maxLength: 80
                  description: Name shown on the tab, 1 to 80 characters after trimming.
                  example: Hot leads in Paris
                icon:
                  $ref: '#/components/schemas/ViewIcon'
                visibility:
                  $ref: '#/components/schemas/ViewVisibility'
                filters:
                  $ref: '#/components/schemas/ViewFiltersInput'
            example:
              entity: contact
              name: Hot leads in Paris
              icon: far fa-fire
              visibility: me
              filters:
                connector: and
                conditions:
                  - property: ownerId
                    operator: is_any_of
                    value:
                      - __me__
                  - property: contactScore
                    operator: gte
                    value: 5
                  - property: createdAt
                    operator: is_relative
                    value:
                      mode: last
                      amount: 30
                      unit: day
      responses:
        '201':
          description: View created and pinned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ViewRefResponse'
              example:
                data:
                  id: evw_A1B2C3ExAmPlE9xYz
                  url: >-
                    https://app.lemlist.com/teams/tea_ExAmPlE4f7Kq2Wz9x/lemcrm/contacts?view=evw_A1B2C3ExAmPlE9xYz
        '400':
          description: >-
            Invalid body: an unknown key, a value out of bounds, an unsafe or
            empty name, or an invalid filter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ViewError'
              examples:
                VALIDATION_ERROR:
                  value:
                    error: Validation error
                    code: VALIDATION_ERROR
                WRONG_PARAM_SAFE_STRING:
                  value:
                    error: Parameter is not a safe string
                    code: WRONG_PARAM_SAFE_STRING
                ENTITY_VIEW_NAME_REQUIRED:
                  value:
                    error: View name is required
                    code: ENTITY_VIEW_NAME_REQUIRED
                ENTITY_VIEW_INVALID_FILTER:
                  value:
                    error: >-
                      Invalid filter on "contactScore": operator must be one of
                      eq, neq, gt, lt, gte, lte, is_between, is_empty,
                      is_not_empty
                    code: ENTITY_VIEW_INVALID_FILTER
        '401':
          description: >-
            Unauthorized - invalid or missing API key. An API key with no user
            attached answers `{ "error": "Route unauthorized", "code":
            "ROUTE_UNAUTHORIZED" }` in JSON instead.
          content:
            text/plain:
              example: The authentication you supplied is incorrect
        '403':
          description: >-
            That list's views are not enabled for your team, or `visibility:
            "everyone"` without the "Create views for the team" permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ViewError'
              examples:
                ENTITY_VIEW_ENTITY_UNAVAILABLE:
                  value:
                    error: Views of this list are not enabled for this team
                    code: ENTITY_VIEW_ENTITY_UNAVAILABLE
                ENTITY_VIEW_TEAM_NOT_ALLOWED:
                  value:
                    error: >-
                      You do not have the permission to edit views shared with
                      the team
                    code: ENTITY_VIEW_TEAM_NOT_ALLOWED
        '409':
          description: The scope already holds 200 views
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ViewError'
              example:
                error: Maximum number of views reached
                code: ENTITY_VIEW_LIMIT_REACHED
components:
  schemas:
    ViewEntity:
      type: string
      enum:
        - contact
        - company
        - task
      description: >-
        The list a view belongs to: `contact` (Contacts page), `company`
        (Companies page) or `task` (Tasks page)
      example: contact
    ViewIcon:
      type: string
      enum:
        - far fa-folder
        - far fa-list-check
        - far fa-star
        - far fa-flag
        - far fa-bolt
        - far fa-bullseye
        - far fa-calendar
        - far fa-user
        - far fa-phone
        - far fa-fire
        - far fa-reply
        - far fa-plane-departure
        - far fa-triangle-exclamation
        - far fa-circle-check
      description: >-
        Font Awesome icon shown on the tab. Defaults to `far fa-folder` on
        create.
      example: far fa-fire
    ViewVisibility:
      type: string
      enum:
        - me
        - everyone
      description: >-
        `me`: private to its owner. `everyone`: shared with the team, which
        needs the "Create views for the team" permission. Defaults to `me` on
        create.
      example: me
    ViewFiltersInput:
      type: object
      additionalProperties: false
      required:
        - conditions
      description: A view's filters. On update, they replace all the current filters.
      properties:
        connector:
          type: string
          enum:
            - and
            - or
          default: and
          description: How the conditions combine
        conditions:
          type: array
          maxItems: 30
          description: Up to 30 conditions; an empty list shows every record
          items:
            $ref: '#/components/schemas/ViewCondition'
      example:
        connector: and
        conditions:
          - property: ownerId
            operator: is_any_of
            value:
              - __me__
          - property: contactScore
            operator: gte
            value: 5
          - property: createdAt
            operator: is_relative
            value:
              mode: last
              amount: 30
              unit: day
    ViewRefResponse:
      type: object
      properties:
        data:
          type: object
          required:
            - id
            - url
          properties:
            id:
              type: string
              description: Id of the view
              example: evw_A1B2C3ExAmPlE9xYz
            url:
              type: string
              description: Opens the list on that view
              example: >-
                https://app.lemlist.com/teams/tea_ExAmPlE4f7Kq2Wz9x/lemcrm/contacts?view=evw_A1B2C3ExAmPlE9xYz
    ViewError:
      type: object
      description: Error envelope returned by the views endpoints.
      properties:
        error:
          type: string
          description: Human-readable explanation of the failure
        code:
          type: string
          description: Machine-readable error code, stable across releases
    ViewCondition:
      type: object
      additionalProperties: false
      required:
        - property
        - operator
      description: One filter condition of a view.
      properties:
        property:
          type: string
          minLength: 1
          maxLength: 128
          description: >-
            Field id, from [Get View
            Fields](/api-reference/endpoints/views/get-view-fields)
            (`fields[].id`)
          example: contactScore
        operator:
          type: string
          enum:
            - contains
            - does_not_contain
            - is
            - is_not
            - starts_with
            - ends_with
            - is_empty
            - is_not_empty
            - eq
            - neq
            - gt
            - lt
            - gte
            - lte
            - is_between
            - is_before
            - is_after
            - is_on_or_before
            - is_on_or_after
            - is_relative
            - is_any_of
            - is_none_of
            - contains_any_of
            - contains_all_of
            - is_true
            - is_false
            - is_not_true
            - is_not_false
          description: One of the operators that field offers (`fields[].operators`)
          example: gte
        value:
          description: >-
            Shaped by the operator and the field type:


            - no value for `is_empty`, `is_not_empty`, `is_true`, `is_false`,
            `is_not_true`, `is_not_false`;

            - a list of 1 to 50 values for `is_any_of`, `is_none_of`,
            `contains_any_of`, `contains_all_of`, also accepted on a text field
            for `contains`, `does_not_contain`, `starts_with`, `ends_with`
            (matching any of them);

            - `{ "from", "to" }` for `is_between`, one side may be omitted;

            - `{ "mode", "amount", "unit" }` for `is_relative`, with `mode`
            among `this`, `last`, `next`, `past` and `unit` among `day`, `week`,
            `month`, `quarter`, `year`;

            - one value otherwise: a number on a number field, an ISO 8601 date
            (`YYYY-MM-DD`) or date-time with offset on a date field, a string on
            the others.


            A field listing `options` takes their `value`. A user, list or
            campaign field takes record ids: user ids from [Get
            Team](/api-reference/endpoints/team/get-team), list ids from [Get
            Contact Lists](/api-reference/endpoints/contacts/get-contact-lists)
            or [Get Company
            Lists](/api-reference/endpoints/companies/get-company-lists),
            campaign ids from [Get Many
            Campaigns](/api-reference/endpoints/campaigns/get-many-campaigns).
          oneOf:
            - type: string
              maxLength: 400
            - type: number
            - type: array
              minItems: 1
              maxItems: 50
              items:
                oneOf:
                  - type: string
                    maxLength: 400
                  - type: number
            - type: object
              title: Range
              properties:
                from:
                  oneOf:
                    - type: string
                    - type: number
                to:
                  oneOf:
                    - type: string
                    - type: number
            - type: object
              title: Relative date
              required:
                - mode
                - unit
              properties:
                mode:
                  type: string
                  enum:
                    - this
                    - last
                    - next
                    - past
                amount:
                  type: integer
                  minimum: 0
                unit:
                  type: string
                  enum:
                    - day
                    - week
                    - month
                    - quarter
                    - year
          example: 5
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.