REST API Guidelines & Best Practices

Created by Aline Gill, Modified on Wed, 3 Jun at 2:42 PM by Aline Gill

DXP Platform – Events & Places REST API Overview


The DXP REST API gives your team direct, structured access to the events and places data powering your hub. Whether you're building a custom front-end, connecting a CRM, or automating content delivery through an agency workflow, these endpoints are designed to fit cleanly into your existing stack.

For technical teams, the API provides paginated, filterable feeds for both events and places — with support for date ranges, text search, category filters, featured/editor-choice flags, and field-level projection. Each endpoint returns everything needed to build and maintain public-facing pages — from listing views to detail cards — with consistent response shapes and built-in support for multiple hub configurations under a single base route.

For CRM and third-party integrations, the API supports targeted data pulls using source feed filters, custom category IDs, and approval state controls, making it straightforward to sync specific subsets of content into external platforms without over-fetching.


SEO-Ready: Responses include prebuilt SEO metadata (meta titles, descriptions, canonical URLs, and JSON-LD structured data) ready to drop into server-rendered pages without extra processing. SEO data is included by default, so pages are crawler-ready from the first HTML response.


Best Practices & Recommendations


Populating Event Categories


Event categories in the ITI Digital DXP dashboard can be mapped directly to the calendar categories in your CRM or CMS. The dashboard supports unlimited custom categories, giving your team full flexibility to mirror whatever taxonomy your platform uses.


The recommended workflow is straightforward:

  1. Create your desired event category options in the ITI Digital DXP dashboard before go-live.
  2. When approving an event, assign it to the appropriate category at the same time.
  3. The event details and their assigned category are immediately available in the ITI Digital REST API that your CRM/CMS uses to pull data.
  4. Configure your CRM/CMS to automatically route events to the correct local category based on the category value returned in the feed.

Pro tip: Get all CRM/CMS categories created in the ITI dashboard before your integration goes live, and share the full category list with your CRM/CMS team so they can set up their mapping rules in advance.


Determining Event Approval Status in Your CRM/CMS


We recommend configuring your CRM/CMS to automatically mark all events received from the ITI Digital REST API as "Approved." Since events only appear in the feed after they have already been reviewed and approved in the ITI DXP dashboard, no second approval step is needed on the CRM/CMS side. The only events that may still require manual review in your CRM are those submitted directly through your website, outside of the ITI DXP platform.


Event Image Format


Every event in the ITI Digital REST API includes an image. If an organizer does not supply one, the system automatically inserts a placeholder using your destination logo — so your calendar will never display an event without an image. Images are served via URL in .webp format, which is recommended for web performance. If events are appearing in your calendar without images, contact your CRM/CMS provider to confirm that .webp URLs are being handled correctly on their end.


CRM Update Timing


Events approved in the ITI dashboard are immediately reflected in the ITI Digital REST API. However, when those events appear on your live website depends on the sync schedule configured by your CRM/CMS provider. Confirm that schedule with your CRM integration team so both sides have aligned expectations on publication timing.


A Note for DTN Simpleview Customers


Using the ITI Digital DXP REST API has no impact on your existing DTN services or CRM reporting functionality. Both can operate independently without conflict.


Downloadable Technical Guides

Below, as attached, you may find the downloadable technical documentation guides that note best practices and each endpoint's parameters, response shapes, and full example requests.


Please note: 

  • API access is provided to third-party partners at ITI Digital's discretion. 
  • The API Secret Key is unique to each DXP customer, and its use must comply with our Terms of Service, whether by the customer or by a third-party system.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article