API Reference

Complete REST API documentation with all endpoints, parameters, and response formats.

Base URL

https://api.circuleid.com/v1

Authentication

All API requests require authentication using an API key. Include your API key in the request header:

Authorization: Bearer YOUR_API_KEY
POST/passports

Create Passport

Create a new digital product passport

Request Body

{
  "productId": "SKU-12345",
  "name": "Organic Cotton T-Shirt",
  "data": {
    "materials": ["100% Organic Cotton"],
    "origin": "Gujarat, India",
    "carbonFootprint": 2.1
  }
}

Response

{
  "id": "passport_abc123",
  "productId": "SKU-12345",
  "qrCode": "https://circuleid.com/p/abc123",
  "createdAt": "2024-01-15T10:30:00Z"
}
GET/passports/:id

Get Passport

Retrieve a specific passport by ID

Response

{
  "id": "passport_abc123",
  "productId": "SKU-12345",
  "name": "Organic Cotton T-Shirt",
  "data": { ... },
  "scans": 1247,
  "createdAt": "2024-01-15T10:30:00Z"
}
GET/passports

List Passports

List all passports with pagination

Response

{
  "data": [ ... ],
  "total": 1500,
  "page": 1,
  "perPage": 50
}