Skip to content
  • There are no suggestions because the search field is empty.

Using Public APIs

Our Public API suite is designed to enhance your experience within your platform by providing robust endpoints that enable you, the customer, to build your own custom integrations on top of your platform.

To access the public API, you must first authenticate and obtain a credential key, which serves as your Public Token. To get your key, please request this from your Account Director. Once you have your Public Token, visit our publicly available Swagger to access detailed descriptions of our available API endpoints.

Currently we do not enforce rate limits on our Public APIs. We therefore recommended that you factor in your own rate limits when building against the platform APIs to avoid any unintended slow down in overall platform performance.

Here’s an overview of some crucial endpoints and their specific uses:

  • CustomPropertyValues POST /custom-property-values

This endpoint allows you to upsert (update or insert) multiple records of Custom Property Values, enabling dynamic updates to properties as per your business needs.

  • CompanySectors Endpoint POST /company-sectors

This endpoint facilitates the upsert of multiple CompanySector records, allowing you to maintain and update sector information effectively.

  • Service Activity Logs GET /service-activity-logs

Retrieve a paginated list of Service Activity Logs to monitor and review the service interactions over time.

  • User Activity Logs GET /user-activity-logs

This endpoint provides a paginated list of User Activity Logs, offering insights into user interactions within your system.

  • Collection Type Management

Retrieve a paged set of Collection Types GET /collection-types

Create new CollectionType records POST /collection-types

Update specific CollectionType records PUT /collection-types/{id}

  • Recommended Companies POST /recommended-companies

This endpoint allows the creation of multiple RecommendedCompany records while handling duplicates effectively.

When working with the public API it's essential to link your request to a specific company or article within your platform. Your properties cannot exist independently and must be associated with an existing entity in your platform.