API Reference

Collections API

Build collections on the Beauhurst platform and automatically get updates through the API

🚀

Create collections to find companies or people that meet your criteria and use our APIs to access these updates automatically. You can also create collections of a your clients or portfolio to keep track of key updates.

Key details

  • Use your Beauhurst API Key to authorise your request
  • Access the names, collection IDs and number of items for all of the company and people collections in your subscription
  • See which collections have been updated using the modified_since parameter
  • Use these collection IDs in the Company and People APIs to see more detailed data

Parameters

sort string

Which field to use when ordering the results

limit integer

Number of results to return per page

offset integer

The initial index from which to return the results

modified_since string

Return data updated since the date and time entered (YYYY-MM-DD hh:mm:ss)

The Collections object

id string

Collection ID

name string

Name set for that collection

count integer

Number of people or companies in the collection