CrumbPOS API Documentation

Welcome to the Crumb developer documentation. Here you'll find everything you need to integrate with our platform, from authentication to webhooks.

Getting Started

Set up your development environment and make your first API call.

Authentication

Learn about API keys, OAuth 2.0, and securing your integration.

API Endpoints

Complete reference for all REST API endpoints.

Webhooks

Real-time event notifications for orders, payments, and more.

Overview

The Crumb API is organized around REST. Our API accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and authentication.

Base URL

https://api.crumbpos.com/v1

API Versioning

The current version of the API is v1. When we make backwards-incompatible changes, we release a new version. The version is included in the URL path.

Request Format

All POST and PUT requests should include a Content-Type: application/json header. Request bodies should be valid JSON.

Response Format

All responses return JSON. Successful responses include a data object. Error responses include an error object with code and message fields.

// Success response
{
  "data": {
    "id": "ord_123abc",
    "type": "order",
    "attributes": { ... }
  }
}

// Error response
{
  "error": {
    "code": "invalid_request",
    "message": "The order_id parameter is required."
  }
}

Rate Limits

API requests are rate limited to protect system stability. The default limit is 100 requests per minute per API key. Enterprise customers can request higher limits.

Rate limit headers are included in every response:

  • X-RateLimit-Limit: Maximum requests per minute
  • X-RateLimit-Remaining: Requests remaining in current window
  • X-RateLimit-Reset: Unix timestamp when the limit resets

Need Help?

If you have questions about the API or run into issues, we're here to help: