Core API Overview
The Core API enables businesses to manage client relationships, store structured data, and build flexible workflows around a central concept: Content Types.
Rather than enforcing a fixed schema, the platform allows you to define data structures that match your business requirements. This flexible approach makes it easier to support complex, customised, or evolving workflows.
Getting Started
Before using the API, ensure you have:
- An active Core website
- Valid authentication tokens
- An API client for testing requests (Postman is recommended)
Content Types
Content Types are configurable collections of fields used to structure and organise your data.
They allow you to define how information is stored, validated, and related across your system, ensuring your data model reflects your business processes.
Example: Client
A Client content type might contain:
name(string)email(string)company(string)status(list option)account_number(integer)notes(text)
Example: Project
A Project content type might contain:
title(string)start_date(datetime)end_date(datetime)assigned_client(relation/select)budget(float)
Base URL
All API requests use the following structure:
Parameters
| Parameter | Description |
|---|---|
company |
Your registered Core account identifier |
version |
The API version to target (for example, v1) |
HTTP Methods
The Core API uses standard HTTP methods to define the action performed on a resource.
| Method | Purpose |
|---|---|
GET |
Retrieve data from a resource |
POST |
Create a resource or execute an action |
PATCH |
Partially update a resource, or upsert a resource (create if it does not exist) |
PUT |
Replace an existing resource |
DELETE |
Remove a resource |
Support
If you need assistance with the API, contact:
For any queries about the web interface, see the official documentation: