Peeap API Documentation

Build powerful integrations with Peeap's merchant services API.

Base URL

https://api.peeap.com/api/v1

Overview

The Peeap API provides programmatic access to Peeap's merchant services including Point of Sale (POS), Invoicing, and Event Management. Use our REST API to build custom integrations, automate workflows, and extend your business capabilities.

Available APIs

POS API

Manage products, categories, sales, and inventory for your point of sale system.

ProductsCategoriesSalesInventory

Invoices API

Create, manage, and send professional invoices to your customers.

CreateUpdateSend

Events API

Manage events, sell tickets, and handle ticket scanning at the door.

EventsTicketsScanning

Quick Start

Get your API key

Make your first request

Test your API key by fetching your products:

bash

curl -X GET "https://api.peeap.com/api/v1/pos/products" \
  -H "X-API-Key: sk_live_your_api_key"

Build your integration

Explore the API documentation to learn about all available endpoints and start building.

Response Format

All API responses follow a consistent JSON format:

json

// Success response
{
  "success": true,
  "data": { ... },
  "timestamp": "2025-01-15T10: 30: 00.000Z"
}

// Paginated response
{
  "success": true,
  "data": [ ... ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "has_next_page": true
  }
}

// Error response
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key"
  }
}