> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ziplined.io/llms.txt
> Use this file to discover all available pages before exploring further.

# The saved views

> Lists all of the user's saved views (saved lists of people or companies), most recently used first. A view is a named list in the Ziplined sidebar. A filter view holds whoever matches its filter right now. A hand_picked view holds the people somebody put in it, and says how many. Each view lists its syncs (where it sends people) with their status. People views carry sync_setup_url and sync_setup_urls (clay, sheets). Share those exact links when the user wants to set up a sync in the app. Opening one never starts a sync.

Use when: The user asks which views or lists they have, or which of them send people where (Slack, Sheets, Clay). Also when the user names a view you cannot match.

Do not use for: One view the user names, with its filter and its number of people (use get_view instead). The people in a view (use search_people with view instead). Sending people (use save_sync or send_people instead).

Example: {"resource":"people","limit":20}



## OpenAPI

````yaml /openapi.json get /v1/views
openapi: 3.1.0
info:
  title: Ziplined API
  version: 1.0.0
  description: >-
    LinkedIn engagement data about people, companies and posts. The workspace
    comes from the credential; lists page with `limit` and `cursor`.
servers:
  - url: https://api.ziplined.io
    description: Production
security: []
tags:
  - name: People
    description: The people in your workspace, and what you sent them.
  - name: Companies
    description: The companies those people work at.
  - name: Posts
    description: Your own posts and their numbers.
  - name: Engagements
    description: One act by one person on one post.
  - name: Insights
    description: Period against period, and the series behind it.
  - name: Views
    description: The saved views of the app, and who is in a hand-picked one.
  - name: Audiences
    description: The scored target groups, and their membership.
  - name: ICP
    description: 'Who you sell to: the rules every person is scored against.'
  - name: Sources
    description: What your radar collects from.
  - name: Account
    description: Who is asking, what is set up, and what is next.
  - name: Credits
    description: What is left to spend on sources, and when it resets.
  - name: Integrations
    description: 'Where syncs send people: webhook, email, Slack and app destinations.'
paths:
  /v1/views:
    get:
      tags:
        - Views
      summary: The saved views
      description: >-
        Lists all of the user's saved views (saved lists of people or
        companies), most recently used first. A view is a named list in the
        Ziplined sidebar. A filter view holds whoever matches its filter right
        now. A hand_picked view holds the people somebody put in it, and says
        how many. Each view lists its syncs (where it sends people) with their
        status. People views carry sync_setup_url and sync_setup_urls (clay,
        sheets). Share those exact links when the user wants to set up a sync in
        the app. Opening one never starts a sync.


        Use when: The user asks which views or lists they have, or which of them
        send people where (Slack, Sheets, Clay). Also when the user names a view
        you cannot match.


        Do not use for: One view the user names, with its filter and its number
        of people (use get_view instead). The people in a view (use
        search_people with view instead). Sending people (use save_sync or
        send_people instead).


        Example: {"resource":"people","limit":20}
      parameters:
        - schema:
            type: string
            enum:
              - people
              - companies
              - content
            description: Only the views about people, companies or content.
          required: false
          description: Only the views about people, companies or content.
          name: resource
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
          required: false
          name: limit
          in: query
        - schema:
            type: string
            description: >-
              The `cursor` from the previous page, with the same other
              arguments.
          required: false
          description: The `cursor` from the previous page, with the same other arguments.
          name: cursor
          in: query
      responses:
        '200':
          description: The result
          content:
            application/json:
              schema:
                type: object
                properties:
                  views:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        resource:
                          type: string
                          enum:
                            - people
                            - companies
                            - content
                          description: What this view lists.
                        kind:
                          type: string
                          enum:
                            - filter
                            - hand_picked
                          description: >-
                            filter updates itself: whoever matches is in it.
                            hand_picked holds the people somebody put in it.
                        icon:
                          type: string
                          nullable: true
                        member_count:
                          type: integer
                          nullable: true
                          description: >-
                            Hand-picked only: how many people the list shows,
                            the count next to the view in the app. Like the
                            list, it leaves out people marked not a fit (any
                            reason) and erased people. It also leaves out the
                            people that the "Always left out" rules leave out.
                        system_key:
                          type: string
                          nullable: true
                          enum:
                            - your_audience_people
                            - competitors_people
                            - experts_people
                            - your_audience_companies
                            - competitors_companies
                            - experts_companies
                            - your_posts
                            - competitors_posts
                            - experts_posts
                            - null
                          description: Which built-in view this is, or null.
                        sync_setup_url:
                          type: string
                          nullable: true
                          description: >-
                            Opens sync setup for this People view in the app.
                            Never starts a sync.
                        sync_setup_urls:
                          type: object
                          nullable: true
                          properties:
                            clay:
                              type: string
                            sheets:
                              type: string
                          required:
                            - clay
                            - sheets
                        created_at:
                          type: string
                        last_used_at:
                          type: string
                          nullable: true
                        syncs:
                          type: array
                          items:
                            type: object
                            properties:
                              destination_id:
                                type: string
                              status:
                                type: string
                                enum:
                                  - active
                                  - paused
                                description: >-
                                  From the stored sync settings. active: it
                                  sends. paused: it sends nothing, because it is
                                  off or has no mode on.
                            required:
                              - destination_id
                              - status
                          description: >-
                            Where this view sends its people; paused sends
                            nothing.
                      required:
                        - id
                        - name
                        - resource
                        - kind
                        - icon
                        - member_count
                        - system_key
                        - sync_setup_url
                        - sync_setup_urls
                        - created_at
                        - last_used_at
                        - syncs
                  total:
                    type: integer
                  cursor:
                    type: string
                    nullable: true
                    description: >-
                      Pass this as `cursor` to get the next page. Null on the
                      last page.
                  truncated:
                    type: boolean
                    description: True when there are more rows than this page shows.
                  empty_reason:
                    type: string
                    enum:
                      - no_sources
                      - no_views
                  next_step:
                    type: object
                    properties:
                      kind:
                        type: string
                        enum:
                          - tool
                      tool:
                        type: string
                    required:
                      - kind
                      - tool
                required:
                  - views
                  - total
                  - cursor
                  - truncated
        '400':
          description: A filter value is invalid, or this resource has no such filter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Wrong workspace, or the credential lacks the required scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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