---
title: Using Public APIs
description: Using Public APIs
---

[Skip to content](https://dealengine.tech/help-guide/using-public-apis#main-content)

[![Help Guide Logo](https://dealengine.tech/hubfs/Help%20Guide%20Logo.svg)](https://dealengine.tech/help-guide?hsLang=en)

Open main navigation

Close main navigation

 What are you looking for?

- There are no suggestions because the search field is empty.

1. [Help Guide](https://dealengine.tech/help-guide?hsLang=en)
2. [Admin & Settings](https://dealengine.tech/help-guide/admin-settings?hsLang=en)
3. [Platform customisation](https://dealengine.tech/help-guide/admin-settings?hsLang=en#platform-customisation)

# 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](https://api.sales.filament.syfter.ai/api/documentation/v1/swagger/public-api/) 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.

- [Getting started](https://dealengine.tech/help-guide/getting-started?hsLang=en)
- [Admin & Settings](https://dealengine.tech/help-guide/admin-settings?hsLang=en#main-content)

    - [Platform customisation](https://dealengine.tech/help-guide/admin-settings?hsLang=en#platform-customisation)
    - [User menu](https://dealengine.tech/help-guide/admin-settings?hsLang=en#user-menu)
    - [Data Management](https://dealengine.tech/help-guide/admin-settings?hsLang=en#data-management)
    - [Alerts & Emails](https://dealengine.tech/help-guide/admin-settings?hsLang=en#alerts-emails)
- [All Companies](https://dealengine.tech/help-guide/all-companies?hsLang=en#main-content)

    - [Using and Saving Filters](https://dealengine.tech/help-guide/all-companies?hsLang=en#using-and-saving-filters)
    - [Other Features](https://dealengine.tech/help-guide/all-companies?hsLang=en#other-features)
- [Company Profile](https://dealengine.tech/help-guide/company-profile?hsLang=en#main-content)

    - [Company Profile Options](https://dealengine.tech/help-guide/company-profile?hsLang=en#company-profile-options)
    - [Overview Tab](https://dealengine.tech/help-guide/company-profile?hsLang=en#overview-tab)
    - [Other Tabs](https://dealengine.tech/help-guide/company-profile?hsLang=en#other-tabs)
- [Recommendations](https://dealengine.tech/help-guide/recommendations?hsLang=en#main-content)

    - [Company Recommendations](https://dealengine.tech/help-guide/recommendations?hsLang=en#company-recommendations)
- [Collections](https://dealengine.tech/help-guide/collections?hsLang=en#main-content)

    - [Collections Page](https://dealengine.tech/help-guide/collections?hsLang=en#collections-page)
    - [Within a Collection](https://dealengine.tech/help-guide/collections?hsLang=en#within-a-collection)
- [News](https://dealengine.tech/help-guide/news?hsLang=en#main-content)

    - [Using and Saving Filters](https://dealengine.tech/help-guide/news?hsLang=en#using-and-saving-filters)
    - [News Articles](https://dealengine.tech/help-guide/news?hsLang=en#news-articles)
    - [Watchlist](https://dealengine.tech/help-guide/news?hsLang=en#watchlist)
- [Transactions](https://dealengine.tech/help-guide/transactions?hsLang=en#main-content)

    - [Using and Saving Filters](https://dealengine.tech/help-guide/transactions?hsLang=en#using-and-saving-filters)

[![Deal Engine logo](https://dealengine.tech/hs-fs/hubfs/Logo-blue-black.png?width=200&height=32&name=Logo-blue-black.png "Deal Engine logo")](https://filament.ai/?hsLang=en)

Copyright © 2026, Filament Consultancy Group Limited trading as Deal Engine