Skip to content

Core API Documentation

The Core API allows you to integrate with Core programmatically, manage structured business data, and build workflows around your organisation's requirements.

Use the API to work with Content Types — configurable data structures that let you model the information your business needs without being restricted to a fixed schema.

This documentation covers authentication, API requests, data structures, and the conventions you need to integrate with Core.

Quick Start

To get started with the Core API, you will need:

  • An active Core website.
  • Valid API authentication credentials. Follow the Authentication Guide tutorial to set these up.
  • An API client, such as Postman, or a command-line tool such as curl.

1. Configure your API URL

All API requests use the following base URL:

https://{company}.core-software.co.uk/api/{version}

Replace the placeholders with your account identifier and the API version you want to use.

Parameter Description
company Your registered Core account identifier
version The API version, such as v1.

2. Authenticate your requests

Before making API requests, complete the Authentication Guide tutorial to configure your credentials.

All requests must use the authentication method supported by the relevant API endpoint. Refer to the authentication documentation for setup instructions and usage details.

3. Make your first request

Once you have configured authentication, you can use an API client to send requests to Core.

For example, a request using curl follows this general structure:

curl -X GET "https://{company}.core-software.co.uk/api/{version}/{endpoint}"
-H "Authorization: Bearer YOUR_TOKEN"
-H "Accept: application/json"

Replace {company}, {version}, {endpoint}, and YOUR_TOKEN with the appropriate values for your account and API.

This is a request template rather than a verified endpoint example. Check the relevant endpoint documentation for the correct path, authentication scheme, and required headers.

Key Concepts

Content Types

Content Types define the structure of the data stored in Core. Each Content Type can have its own fields, allowing you to model information around your business processes.

For example, a Client Content Type might include:

  • name (string)
  • email (string)
  • company (string)
  • status (list option)
  • account_number (integer)
  • notes (text)

A Project Content Type might include:

  • title (string)
  • start_date (datetime)
  • end_date (datetime)
  • assigned_client (relation/select)
  • budget (float)

These examples illustrate how Content Types can represent different types of business data.

API Reference

Use the relevant documentation to find the endpoints, parameters, request formats, and responses for your integration.

  • Authentication — instructions for setting up API authentication.
  • Content Types — documentation on defining and working with structured data.
  • API Endpoints — reference for available API operations.
  • Errors and Troubleshooting — guidance on handling API errors and resolving common issues.

Replace the placeholder references above with links to the relevant pages as they become available.

Support

For assistance with the Core API, contact [email protected].

For documentation relating to the Core web interface, visit the Core Documentation Site.