---
title: "Get the configuration details required to construct a search request accurately"
method: GET
path: "/search/setup"
tags: ["Search"]
---

# Get the configuration details required to construct a search request accurately

`GET /search/setup`

## Request

- Base URL: `https://api.streamtime.net/v2`
- URL: `https://api.streamtime.net/v2/search/setup`
- Auth: HTTP bearer

This route gives you the required background information in order to perform a search.

## Query parameters

- `search_view` 'jobs' | 'job_milestones' | 'job_phases' | 'job_items' | 'job_item_quote_line_items' | 'job_item_invoice_line_items' | 'job_item_users' | 'job_item_roles' | 'job_item_sub_items' | 'time' | 'expenses' | 'purchase_order_line_items' | 'logged_expense_quote_line_items' | 'logged_expense_invoice_line_items' | 'quotes' | 'quote_line_items' | 'quote_line_item_invoice_line_items' | 'invoices' | 'invoice_line_items' | 'job_groups' | 'job_group_periods' | 'companies' | 'contacts' | 'users', required: Which search context is being referred to.

## Response `200`

Details about what options are available when performing your search

- object
  - `filters` object[]: A list of filters to choose from with details about each type
    - `selector` string: The name to be used when constructing a search
    - `name` string
    - `description` string
    - `filterType` string
  - `additionalData` string[]: When performing a search, you can request additional related data to the record itself. This is a list of the available options to pass when performing a search. For instance, if you're searching for jobs but also want information about the company, you can pass 'company' as an additional data option to get the company details for each job in the search results.
  - `sortColumns` string[]: The list of columns that you can sort the results by when executing a search.

---

[API](https://skmtc.dev/streamtime/apis/public-api.md) · [All operations](https://skmtc.dev/streamtime/apis/public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/streamtime/apis/public-api/revisions/cda8d1405534?raw)