Starred searches

List starred searches

The list views you have starred. Defaults to 5 per page.

get/starred_searches

Request

  • Base URL: https://api.pipelinecrm.com/api/v3
  • URL: https://api.pipelinecrm.com/api/v3/starred_searches
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer and API key in header app-key
    • API key in query parameter api_key and API key in query parameter app_key

Query parameters

search_type'deals' | 'people' | 'companies' | 'activities'

Only starred searches of this type

include_search_detailsboolean

Add search_type, result_count, url and updated_at to each entry

pageinteger

Page number

per_pageinteger

Records per page, at most 200

Response

Successful Response

Example response

{
  "entries": [
    {
      "name": "My hot deals",
      "search_type": "deals"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 200,
    "total": 670,
    "pages": 4,
    "total_in_account": 1204,
    "page_var": "page",
    "url": "/api/v3/deals.json"
  }
}

Changes

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