Documentation / API

API

Access your SuitTracker data programmatically using API keys and the public REST API.

The SuitTracker public API lets external applications read data from your store — weddings, customers, orders, and activity — using an API key you generate from your store's settings. The API is currently read-only.

Creating an API Key

API keys are managed in Settings → Advanced → API.

1 Click Create API Key.
2 Give the key a Name that identifies what it's used for (e.g. "Zapier Integration").
3 Choose View and/or Edit permissions for each data type the key should be able to access.
4 Optionally set an Expiration date, or leave it set to never expire.
5 Click Create. Your key is shown once, in full — copy it and store it somewhere safe. For security, it cannot be viewed again after this point.

If you lose a key, you cannot recover it — revoke it from the API settings page and create a new one instead.

Authentication

Every request must include your API key as a bearer token in the Authorization header:

Authorization: Bearer <your-api-key>

Requests without a valid, unexpired key return a 401. Requests for data the key doesn't have permission to access return a 403.

Permissions

Each API key is granted View and/or Edit access per data type. Since the API is currently read-only, Edit permissions are reserved for future write endpoints and don't grant any additional access today.

Permission	View	Edit
CUSTOMER	Yes	Yes
WEDDING	Yes	Yes
ORDER	Yes	Yes
ACTIVITY	Yes	—

Endpoints

All endpoints are relative to the base URL https://api.suittracker.app and return JSON. Every endpoint below requires View access to the listed permission.

Method	Path	Permission	Description
GET	/activity/today	ACTIVITY	Entities created or modified today.
GET	/wedding/{id}	WEDDING	A single wedding.
GET	/wedding/{weddingId}/membership/{id}	WEDDING	A single wedding party member.
GET	/customer/{id}	CUSTOMER	A single customer.
GET	/order/{id}	ORDER	A single order.
GET	/order/{orderId}/item/{id}	ORDER	A single garment/item on an order.

Example Request

curl -H "Authorization: Bearer <your-api-key>" \
  "https://api.suittracker.app/customer/67890"

{
  "id": "67890",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phone": "5551234567",
  "fullName": "John Doe"
}

Errors

Status	Meaning
401	Missing, invalid, or expired API key.
403	The key doesn't have permission to access this resource.
404	The requested record doesn't exist.

← Previous Webhooks