Search

Get the configuration details required to construct a search request accurately

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

get/search/setup

Request

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

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.

Get the specific details of what filters and data is available for a given search.

Response

Details about what options are available when performing your search

additionalDatastring[]

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.

sortColumnsstring[]

The list of columns that you can sort the results by when executing a search.

Example response

{
  "filters": [
    {
      "selector": "job_start_date",
      "name": "Job Start Date",
      "description": "The date the job started",
      "filterType": "Date"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.