Technical Resources

API Documentation

Integrate Fareplay directly into your existing systems. Our RESTful API gives you programmatic access to orders, menus, cart tracking, and analytics data so you can build custom workflows tailored to your venue.

* Customer Facing API access available for a monthly fee

Contact our sales team or visit your admin dashboard for pricing details.

RESTful Architecture

Clean, predictable resource-oriented URLs with standard HTTP methods and status codes.

JSON Responses

All responses are returned in JSON format with consistent structure and error handling.

API Key Authentication

Secure authentication using API keys passed via the Authorization header on every request.

Base URL

https://api.fareplaygolf.com

All API requests should be made to this base URL. Use HTTPS for all requests.

Authentication

Authenticate every request by including your API key in the Authorization header. API keys are generated in your Fareplay admin dashboard under Settings > API Access.

# Include this header with every request

Authorization: Bearer fp_live_your_api_key_here

Keep your API keys secure. Never expose them in client-side code, public repositories, or browser requests. Use environment variables or a secrets manager.

Available Endpoints

The Fareplay API provides access to all the data you need for custom integrations, reporting, and automation.

MethodEndpointDescription
GET/api/v1/ordersList all orders with filtering, pagination, and date range support.
GET/api/v1/orders/:idRetrieve full details for a specific order including items, status, and delivery info.
GET/api/v1/menuGet all menu items with categories, pricing, availability, and modifier groups.
PUT/api/v1/menu/:idUpdate a menu item including name, price, description, and availability status.
GET/api/v1/cartsGet real-time cart locations, online/offline status, and assigned zones.
GET/api/v1/analytics/salesSales reporting data with breakdowns by day, item, cart, and time period.
GET/api/v1/analytics/popular-itemsRanked list of most popular menu items by order volume and revenue.

Example Request

curl -X GET https://api.fareplaygolf.com/api/v1/orders \
  -H "Authorization: Bearer fp_live_abc123def456" \
  -H "Content-Type: application/json" \
  -d '{"status": "completed", "limit": 10}'

Example Response

HTTP/1.1 200 OK

{
  "data": [
    {
      "id": "ord_8x7kLm2nP",
      "status": "completed",
      "created_at": "2026-03-17T14:32:00Z",
      "hole_number": 7,
      "cart_id": "cart_3fR9v",
      "items": [
        {
          "id": "item_kL8m2",
          "name": "Draft IPA",
          "quantity": 2,
          "unit_price": 8.00,
          "modifiers": ["Extra cold"]
        },
        {
          "id": "item_pQ4n7",
          "name": "Turkey Wrap",
          "quantity": 1,
          "unit_price": 12.50,
          "modifiers": []
        }
      ],
      "subtotal": 28.50,
      "tax": 2.28,
      "tip": 5.00,
      "total": 35.78,
      "delivery_time_seconds": 342,
      "customer": {
        "name": "Jordan M.",
        "phone_last_four": "4821"
      }
    }
  ],
  "meta": {
    "total": 147,
    "page": 1,
    "per_page": 10,
    "has_more": true
  }
}

Rate Limiting

API requests are limited to 1,000 requests per hour per API key. Rate limit headers are included in every response so you can track your usage.

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 847
X-RateLimit-Reset: 1742234400

If you exceed the limit, you will receive a 429 Too Many Requests response. Wait until the reset timestamp before retrying.

Ready to integrate?

Sign up for Fareplay and generate your API keys from the admin dashboard. Our team is here to help you build the perfect integration for your venue.

Get Started