New Companies

Save a new-company search

Saves the feed filters (sic, region, town, postcode, type, shared_address, directors_with_other_companies, status) as a search. Every 15 minutes each search's new matches (companies incorporated since it was saved) are recorded, and on the API each one is sent to webhook_url as a signed POST: type new_company.matched, the CompanyStack-Signature header (HMAC-SHA256 with your account's webhook signing secret, as for list alerts), the company in data.company. Limits: 1 search on API Free, 5 on Starter, 50 on Business.

post/saved-searches

Request

  • Base URL: https://api.companystack.co.uk
  • URL: https://api.companystack.co.uk/saved-searches
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Request body

namestring required
filtersobject required
webhook_urlstring uri required

https URL on the public internet

Example request

{
  "filters": {
    "sic": "56101",
    "postcode": "LS1"
  }
}

Response

Saved

Changes

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