Brivio API reference
Prospecting

Save a prospecting search. Counts toward the plan limit (402 PLAN_LIMIT_EXCEEDED). The row is attributed to the user who created the API key; 403 when the credential has no such member. Honours Idempotency-Key. (scope: prospecting:write)

POST
/prospecting/saved-searches

Authorization

bearerAuth
headerAuthorizationBearer <token>

API key as Bearer token

Request Body

application/json
  1. body
name*string
Length1 <= length <= 200
filters*

The @brivio/registry-search filter model: { groups: FilterGroup[] } (AND between groups, OR within).

sort?string
Value in"relevance""name""nameDesc""revenue""revenueAsc""employees""employeesAsc""foundedNewest""foundedOldest"
columns?array<>
Itemsitems <= 40
notify_in_app?boolean
notify_email?boolean

Response Body

OK

application/json
  1. response
data*
error*null
curl -X POST "https://example.com/prospecting/saved-searches" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "filters": {      "groups": [        {}      ]    }  }'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "filters": {},    "sort": "string",    "columns": [      "string"    ],    "notify_in_app": true,    "notify_email": true,    "last_run_at": "2019-08-24T14:15:22Z",    "last_match_count": 0,    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  },  "error": null}