> ## 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 People filter vocabulary

> Lists the fields a people filter can use (country, seniority, industry, activity and more) with their allowed values. Returns every field a People filter can use, and what each field means. A field with a closed set of values also lists its valid_values. For industry, these are the industries that this workspace has. A filter is { field: values }. Different fields must all match (AND). Several values in one field are alternatives (OR). search_people takes the same fields as arguments, and save_view keeps them as a view.

Use when: Before writing a filter for search_people or save_view with a field you have not seen in get_view.

Do not use for: The people themselves (use search_people instead).



## OpenAPI

````yaml /openapi.json get /v1/views/filter-options
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/filter-options:
    get:
      tags:
        - Views
      summary: The People filter vocabulary
      description: >-
        Lists the fields a people filter can use (country, seniority, industry,
        activity and more) with their allowed values. Returns every field a
        People filter can use, and what each field means. A field with a closed
        set of values also lists its valid_values. For industry, these are the
        industries that this workspace has. A filter is { field: values }.
        Different fields must all match (AND). Several values in one field are
        alternatives (OR). search_people takes the same fields as arguments, and
        save_view keeps them as a view.


        Use when: Before writing a filter for search_people or save_view with a
        field you have not seen in get_view.


        Do not use for: The people themselves (use search_people instead).
      responses:
        '200':
          description: The result
          content:
            application/json:
              schema:
                type: object
                properties:
                  filters:
                    type: array
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                        type:
                          type: string
                          enum:
                            - values
                            - flag
                            - boolean
                            - number
                            - day
                            - activity
                          description: >-
                            values: a list of strings. flag: true. boolean: true
                            or false. number: one number. day: one YYYY-MM-DD.
                            activity: a list of activity rows.
                        description:
                          type: string
                        valid_values:
                          type: array
                          items:
                            type: string
                          description: >-
                            The values this field takes. For industry, the ones
                            seen in this workspace. Absent when the values are
                            open.
                      required:
                        - field
                        - type
                        - description
                  example:
                    type: object
                    additionalProperties:
                      nullable: true
                    description: A filter as search_people and save_view take it.
                required:
                  - filters
                  - example
        '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.