Getting Started

Quickstart

Copy page

Introduction

Scalebespoke is a cloud-based fabrication workflow platform designed for bespoke manufacturers. It covers the full production lifecycle — from initial survey and drawing approvals through to order management, shipping, and installation — giving teams complete operational control at every stage.

The Scalebespoke API allows you to integrate your existing tools and systems directly with the platform, enabling you to automate workflows, synchronise data, and extend functionality programmatically. This guide walks you through everything you need to make your first authenticated request and understand how responses are structured.

Authorization

Scalebespoke uses bearer token authentication. All API requests must include your API key in the Authorization header.

Obtaining an API Key

You can generate an API key in two ways:

1. Visit my.scalebespoke, navigate to the Profile tab, find the corresponding system, and create your API key.
2. Directly through your system — a Super Admin can access the API Keys tab within the System section.

Important: API keys are only displayed once at the time of generation and cannot be retrieved afterwards. Store it in a secure location and give it a descriptive name to avoid confusion within your team.

Making Your First Request

Once you have your API key, include it in the Authorization header of every request. You can verify your setup with the following test call:

Code
GET /ping HTTP/1.1
Host: api.scalebespoke.com
Authorization: Bearer YOUR_API_KEY

A successful response confirms your API key is valid and your requests are authenticated correctly.

Response Structure & Errors

All API responses follow a consistent JSON structure, using a success flag to indicate the outcome of a request.

Successful request

Code
{
  "success": true,
  "data": []
}

Unsuccessful request

Code
{
  "success": false,
  "data": [
    {
      "code": "rest_forbidden",
      "message": "You must be authorised to perform this action."
    }
  ]
}

HTTP Status Codes

Scalebespoke uses conventional HTTP status codes to indicate the result of each request:

Range	Meaning
2xx	The request was successful.
4xx	A client-side error occurred — e.g. invalid data, unknown IDs, or a malformed request.
5xx	A server-side error occurred. These are unexpected and their response structure may not follow the standard format above.

---

Ready to start building? Head over to the API Reference to explore all available endpoints.