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

# One view with its filter and syncs

> Opens one saved view (a saved list) by its name or id. It shows how many people are in it, its filter, and where it sends people. It returns its filter, its match_count and its syncs. The filter uses the words of get_filter_options, in the same shape that save_view takes. match_count is how many people the view shows now. Each sync comes with its status, its last send and its failed sends. list_deliveries shows what each send carried and what the receiver answered. Pass it the destination id of a sync. A hand-picked view also says how many LinkedIn links from add_to_view Ziplined still looks up, and which found nobody.

Use when: The user names one view. They ask how many people are in it, what its filter is, or whether its syncs send. Also before changing a view (start from its filter). The view takes the name as the user says it.

Do not use for: All views at once (use list_views instead). The people themselves (use search_people with view instead). A check before the user sends or syncs the people in a view (use save_sync or send_people instead). Those take the view name and check the view and its syncs themselves.

Example: {"view":"Warm leads NL"}



## OpenAPI

````yaml /openapi.json get /v1/views/{id}
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/{id}:
    get:
      tags:
        - Views
      summary: One view with its filter and syncs
      description: >-
        Opens one saved view (a saved list) by its name or id. It shows how many
        people are in it, its filter, and where it sends people. It returns its
        filter, its match_count and its syncs. The filter uses the words of
        get_filter_options, in the same shape that save_view takes. match_count
        is how many people the view shows now. Each sync comes with its status,
        its last send and its failed sends. list_deliveries shows what each send
        carried and what the receiver answered. Pass it the destination id of a
        sync. A hand-picked view also says how many LinkedIn links from
        add_to_view Ziplined still looks up, and which found nobody.


        Use when: The user names one view. They ask how many people are in it,
        what its filter is, or whether its syncs send. Also before changing a
        view (start from its filter). The view takes the name as the user says
        it.


        Do not use for: All views at once (use list_views instead). The people
        themselves (use search_people with view instead). A check before the
        user sends or syncs the people in a view (use save_sync or send_people
        instead). Those take the view name and check the view and its syncs
        themselves.


        Example: {"view":"Warm leads NL"}
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 200
            description: >-
              The name or the `id` of the view, from `list_views`. A People view
              and a Companies view can share a name; then add the subject, as in
              "Your audience (companies)".
          required: true
          description: >-
            The name or the `id` of the view, from `list_views`. A People view
            and a Companies view can share a name; then add the subject, as in
            "Your audience (companies)".
          name: id
          in: path
      responses:
        '200':
          description: The result
          content:
            application/json:
              schema:
                type: object
                properties:
                  view:
                    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
                      filter:
                        type: object
                        nullable: true
                        properties:
                          status:
                            type: array
                            items:
                              type: string
                              enum:
                                - lead
                                - undecided
                                - not_a_lead
                                - not_my_icp
                                - peer
                                - customer
                            minItems: 1
                            description: >-
                              lead, undecided, not_a_lead, or one not-a-fit
                              reason. not_a_lead is all three reasons.
                          country:
                            type: array
                            items:
                              type: string
                            minItems: 1
                            description: Two-letter ISO country codes, for example NL.
                          warmth:
                            type: array
                            items:
                              type: string
                              enum:
                                - hot
                                - warm
                                - cool
                                - cold
                            minItems: 1
                          seniority:
                            type: array
                            items:
                              type: string
                              enum:
                                - C-Level
                                - Founder
                                - Owner
                                - VP
                                - Director
                                - Manager
                                - Senior
                                - Entry Level
                            minItems: 1
                            description: >-
                              Seniority words from the valid_values of
                              get_filter_options, for example Director or
                              C-Level.
                          connection_degree:
                            type: array
                            items:
                              type: string
                              minLength: 1
                            minItems: 1
                            description: 1st, 2nd or 3rd.
                          industry:
                            type: array
                            items:
                              type: string
                              minLength: 1
                            minItems: 1
                            description: >-
                              Industry names exactly as the valid_values of
                              get_filter_options list them, for example Software
                              Development.
                          is_premium:
                            type: boolean
                          is_verified:
                            type: boolean
                          min_followers:
                            type: integer
                            minimum: 0
                          min_connections:
                            type: integer
                            minimum: 0
                          first_engaged_since:
                            type: string
                            pattern: ^\d{4}-\d{2}-\d{2}$
                            description: >-
                              Whose very first engagement is on or after this
                              UTC day. Not "active lately": for that use an
                              activity row such as has:any:any:30d:min1.
                          first_engaged_until:
                            type: string
                            pattern: ^\d{4}-\d{2}-\d{2}$
                          first_reacted_since:
                            type: string
                            pattern: ^\d{4}-\d{2}-\d{2}$
                          company:
                            type: array
                            items:
                              type: string
                              minLength: 1
                            minItems: 1
                            description: Company ids, from search_companies.
                          job_title:
                            type: array
                            items:
                              type: string
                              minLength: 1
                            minItems: 1
                            description: >-
                              Words their job title or headline contains, any
                              case, for example founder or head of sales.
                              Several is an OR.
                          company_size_min:
                            type: integer
                            minimum: 0
                            description: Their company has at least this many employees.
                          company_size_max:
                            type: integer
                            minimum: 0
                            description: Their company has at most this many employees.
                          post:
                            type: array
                            items:
                              type: string
                              minLength: 1
                            minItems: 1
                            description: >-
                              Post ids from list_posts (the team's, or a tracked
                              source's with source), or LinkedIn post URLs.
                              Matches who engaged with one of them.
                          trend:
                            type: array
                            items:
                              type: string
                              enum:
                                - new
                                - returning
                                - gone_quiet
                                - one_off
                            minItems: 1
                          has_email:
                            type: boolean
                          has_phone:
                            type: boolean
                          sent:
                            type: boolean
                            description: >-
                              Delivered to any destination before, by any sync
                              or send_people. Use sent: false on a view you sync
                              to an outreach tool, so nobody gets two sequences.
                              A person the view's own sync sends then leaves
                              that view, which is harmless for a once sync. An
                              alert does not count as a send.
                          in_view:
                            type: array
                            items:
                              type: string
                              minLength: 1
                            minItems: 1
                            description: >-
                              Hand-picked views they are in, by id or name from
                              list_views.
                          not_in_view:
                            type: array
                            items:
                              type: string
                              minLength: 1
                            minItems: 1
                            description: >-
                              Hand-picked views they are not in, by id or name
                              from list_views.
                          activity:
                            type: array
                            items:
                              type: string
                            minItems: 1
                            description: >-
                              Activity rows, all must hold:
                              polarity:verbs:who:within:count, see
                              get_filter_options. who takes any, team (posts of
                              the team), competitors, market or source ids from
                              list_sources. Example:
                              has:like,comment:competitors:7d:min1 is a like or
                              comment on a competitor post in the last 7 days.
                              Example: has:like:team:30d:min1 is a like on a
                              team post in the last 30 days. Example:
                              not:message_sent:any:ever:min1 means that nobody
                              on the team ever sent them a message.
                        additionalProperties: false
                        description: >-
                          The filter in the shape save_view takes. Null for a
                          Companies or Content view.
                      syncs:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            destination:
                              type: object
                              properties:
                                id:
                                  type: string
                                provider:
                                  type: string
                                name:
                                  type: string
                                  nullable: true
                                status:
                                  type: string
                                  enum:
                                    - connected
                                    - paused
                                    - failed
                                    - disconnected
                              required:
                                - id
                                - provider
                                - name
                                - status
                            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.
                            new_people:
                              type: boolean
                              description: Sends people when they enter the view.
                            activity:
                              type: boolean
                              description: Sends what people in the view do.
                            add_email:
                              type: boolean
                            add_phone:
                              type: boolean
                            last_delivery:
                              type: object
                              nullable: true
                              properties:
                                status:
                                  type: string
                                at:
                                  type: string
                              required:
                                - status
                                - at
                              description: >-
                                The newest send of this sync, or null when it
                                sent nothing yet.
                            failed_deliveries:
                              type: integer
                              description: >-
                                How many of its recent sends failed. See
                                list_deliveries.
                          required:
                            - id
                            - destination
                            - status
                            - new_people
                            - activity
                            - add_email
                            - add_phone
                            - last_delivery
                            - failed_deliveries
                        description: Where this view sends its people.
                    required:
                      - id
                      - name
                      - resource
                      - kind
                      - icon
                      - member_count
                      - system_key
                      - sync_setup_url
                      - sync_setup_urls
                      - created_at
                      - last_used_at
                      - filter
                      - syncs
                  match_count:
                    type: integer
                    nullable: true
                    description: >-
                      How many people the view shows now: the count in its
                      heading in the app. Null when the count failed. The lists
                      hide some people, such as the people that the "Always left
                      out" rules leave out.
                  empty_reason:
                    type: string
                    enum:
                      - view_empty
                  looking_up:
                    type: integer
                    description: >-
                      A hand-picked view: how many LinkedIn links from
                      add_to_view Ziplined still looks up. The people appear
                      when it is done.
                  not_found:
                    type: array
                    items:
                      type: string
                    description: >-
                      A hand-picked view: the LinkedIn links of the last 7 days
                      that found nobody. They cost nothing.
                  app_url:
                    type: string
                required:
                  - view
                  - match_count
                  - app_url
        '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'
        '404':
          description: No such record, or it does not belong to this workspace.
          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.