Searches

Retrieve search results

post/searches/{id}/perform

Request

  • Base URL: https://api.pipelinecrm.com/api/v3
  • URL: https://api.pipelinecrm.com/api/v3/searches/{id}/perform
  • 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

Path parameters

idinteger required

Search ID

Request body

Example request

{
  "search": {
    "name": "Renewals closing this quarter",
    "search_type": "deals",
    "query": {
      "person_name": "James",
      "person_email": "@acme.com"
    },
    "columns": [
      "person_name",
      "person_email"
    ]
  }
}

Response

Successful Response

Example response

{
  "columns": [
    {
      "primary_key": "primary_key"
    }
  ],
  "entries": [
    [
      "value for row 1 column 1",
      "value for row 1 column 2"
    ],
    [
      "value for row 2 column 1",
      "value for row 2 column 2"
    ]
  ],
  "pagination": {
    "page": 1,
    "pages": 34,
    "per_page": 50,
    "total": 1045
  }
}

Changes

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