SmartSearch Platform API Documentation

Getting Started

The SmartSearch Platform API provides many tools and resources that enable you to integrate with all the powerful capabilities within SmartSearch.

Getting Access

Interested in the SmartSearch Platform API? Contact your Relationship Manager or Support@SmartSearchinc.com to get set up. Once provisioned, refer to the Platform API Launch Guide below to get started.

HTTPS Only

The API only responds to HTTPS-secured communications
Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources

Response Format

The API returns request responses in JSON format
Error responses return a JSON body containing a status code and a description of what went wrong

Platform API Launch Guide

The launch guide walks you through authenticating with the API and making your first requests across the available resources. It covers everything from obtaining your credentials and generating a token to calling endpoints and interpreting responses.

Download the guide here to get started.

Webhooks

Webhooks allow your application to receive notifications when events occur in SmartSearch. Once configured, SmartSearch will POST to your endpoint whenever a subscribed event fires. If delivery fails, SmartSearch will retry up to 3 times using an exponential backoff strategy.

⚠️ Webhooks must be enabled before use. Webhook functionality is not active by default. Before you can create any subscriptions through the API, you must contact SmartSearch to have the feature enabled for your account.

How to Get Started with Webhooks

Discover available events — Call GET /references/webHookEvents to retrieve the full list of supported event types and their corresponding IDs.
Request enablement — Contact your Relationship Manager or Support@SmartSearchinc.com and include the specific events you plan to subscribe to. Providing this list upfront ensures only the events relevant to your integration are enabled.
Configure your subscriptions — Once enabled, use POST /webhooks to register your endpoint URL for each event, and manage them with the PUT, PATCH, and DELETE endpoints as needed.

Additional Notes

OData & JSON Patch

The GET endpoints in the SmartSearch Platform API follow the OData standard while the PATCH endpoints utilize the JSON Patch format.

⚠️ PATCH requests require a specific Content-Type header. All PATCH requests must include the Content-Type: application/json-patch+json header. Requests sent without this header will be rejected.

Pagination

By default, the Platform API returns 1,000 records at any given time. If there are more than 1,000 results, it returns a link to get the next set of results.

Timestamps

All incoming timestamps must follow the ISO 8601 format. If no timezone is specified, UTC is assumed by default. Below are examples of valid formats:

UTC timestamp: 2024-08-15T14:30:00Z
Date-only format: 2024-08-15

Ready to Explore the API?

View the complete API reference with all endpoints, request/response schemas, and code examples.

View Full API Documentation →