Overview
The APIs Playground is where you build, configure, and test reusable endpoints — no code. Each endpoint maps an internal CXF operation (fetching content, products, bookings, the current contact, …) to a clean Contact API route, with the parameters you choose to expose. Endpoints power your own site or app and are consumed by Funnels, Events & Automation, and Bundles. For how this fits the platform, see Core concepts.Where to find it
The APIs Playground lives under Orchestration → APIs Playground.APIs Playground vs. Docs explorer. The APIs Playground is where you build,
manage, and test endpoints — fill parameters, run them, and inspect the response.
Endpoints in the Docs explorer is the HTTP client
reference (request shapes, cURL) you’d hand to someone so they can call your
endpoint from their own tools (Postman, etc.).
How an endpoint is built
You don’t wire routes by hand. You start from a Library — a pre-wired endpoint type that already knows which CXF operation to call and which module it belongs to:- Pick a library (e.g. Stories, Products, Me, Funnel flow).
- The library auto-sets some parameters (for example, Stories fixes the content type) and requires you to provide others (for example, which content template to read).
- You configure and expose the remaining parameters.
| Type | Returns |
|---|---|
| Collection | A list of records. |
| Single | One record. |
| Action | A write operation (create, update, trigger). |
Parameters
An endpoint’s parameters control what callers may pass and what stays locked:| Mode | Behaviour |
|---|---|
| Fixed | A locked value the caller can’t change. |
| Exposed | The caller can override it at runtime. |
| Hidden | Auto-set behind the scenes; not shown. |
| Input type | For |
|---|---|
text-input · number-input · boolean-input | Free text, numbers, toggles. |
list-input | A dropdown of options. |
object-selector | Pick an existing record (template, product, …). |
query-builder | A visual filter; you can expose individual conditions. |
sort-input | A field + direction. |
attributes-selector | Which fields to return. |
version-selector | A content language/environment version. |
json-input | Raw JSON (for write bodies). |
Enabling & access
- An endpoint starts disabled — enable it to make it callable through the Contact API (with an API key).
- Authentication is asymmetric: an endpoint inherits the auth requirement of the underlying operation and can require auth on top of an open one, but it can never remove auth from a protected operation.
- An enabled endpoint is locked — to change it, disable it, edit, then re-enable.
Testing in the Playground
Each endpoint has a Playground where you can run it without leaving CXF:- Test as a chosen contact — so authenticated endpoints resolve against a real contact.
- Fill the exposed parameters, and (for write endpoints) preview the body structure with your current values substituted into the template.
- Run it and inspect the generated cURL (including the
api-keyheader) and the response.
…/api/v1/endpoints/{slug} with an api-key header. Test runs
reach even a disabled endpoint, so you can try one before enabling it.
Libraries
A library is a read-only catalog entry that pre-wires an endpoint type to a CXF operation, grouped by module. Representative examples:| Module | Libraries |
|---|---|
| Content | Stories, Products, Locations, Blocks, Taxonomies (collection + single), Bundle, Tags. |
| Customer Data | Me, My products, My bookings, My documents, Create document, Update my data, My organizations. |
| Orchestration | Schedules, Booking templates, Event (triggers an event template), Funnel statistics. |
| Engagement | Funnel flow (fetch a funnel’s structure or submit data). |
Request logging
Every external endpoint call is logged — the endpoint, library, the authenticated contact (if any), IP, status code, and execution time — for analytics, debugging, and auditing. Internal calls (from funnels, automations, bundles) and test-mode calls are not logged, to keep analytics clean.OpenAPI
You can generate an OpenAPI spec of all your configured endpoints, to explore them in a Swagger-style UI or hand them to external clients.How endpoints are used
- Funnels — funnel components and action layers call endpoints to fetch or submit data.
- Events & Automation — the endpoint action calls one; enabling an event template auto-creates an endpoint for it.
- Bundles — aggregate several endpoints into one payload.
Seeds
Seeds support for endpoints is coming soon.Governance & permissions
Only a super admin or Master can create, enable, and delete endpoints.API access
The User API manages endpoints (and lists the available libraries), and the Contact API executes an enabled endpoint by its slug (with an API key). See the API reference.Related
Endpoints (Docs explorer)
The panoramic API reference for how to call your endpoints.
Events & Automation
Call an endpoint from a flow, or expose an event as one.
Engagement Funnels
Funnels fetch and submit data through endpoints.