Quickstart

This guide will get you all set up and ready to use the ibakepro API. We'll cover how to get your API key and make your first API request to retrieve orders from your bakery.

Before you can make requests to the ibakepro API, you will need to generate an API key from your dashboard. You can find it under Business » Developers » API Keys.

Get your API key

Log in to your ibakepro dashboard
Navigate to Business > Developers > API Keys
Click Generate New Key
Select the scopes you need (e.g., orders:read, customers:read)
Copy your API key - it will only be shown once!

Store your API key securely. If you lose it, you'll need to generate a new one. Never commit API keys to version control.

Making your first API request

Once you have your API key, you're ready to make your first call to the ibakepro API. Below, you can see how to send a GET request to the Orders endpoint to retrieve a list of your orders.

GET

/api/v1/orders

curl -G https://api.ibakepro.com/api/v1/orders \
  -H "Authorization: Bearer your_api_key_here" \
  -d limit=10

Read the docs for the Orders endpoint

Example response

Response

{
  "success": true,
  "data": [
    {
      "id": "ord_abc123",
      "order_number": 1001,
      "friendly_order_number": "#1001",
      "status": "confirmed",
      "payment_status": "paid",
      "customer_name": "John Smith",
      "customer_id": "cust_xyz789",
      "items_count": 3,
      "total": 125.00,
      "currency": "AUD",
      "event_date": "2025-02-14",
      "delivery_type": "delivery",
      "created": "2025-01-15T10:30:00Z",
      "source": "app"
    }
  ],
  "pagination": {
    "limit": 10,
    "has_more": true,
    "next_cursor": "eyJpZCI6Im9yZF9hYmMxMjMifQ"
  }
}

What's next?

Great, you're now set up with an API key and have made your first request to the API. Here are a few links that might be handy as you venture further into the ibakepro API:

Authentication guide - Learn about API key authentication
Orders endpoint - Create and manage orders
Customers endpoint - Manage your customer database
Pagination guide - Work with paginated responses
Errors guide - Understand error responses