API Reference

Welcome to the Closer Platform API documentation. This API allows you to build applications that interact with the Closer ecosystem—manage bookings, events, users, payments, and more.

Getting Started

Base URL

https://api.traditionaldreamfactory.com

Authentication

All API requests require authentication using a Bearer token in the HTTP header:

curl -X GET "https://api.traditionaldreamfactory.com/api/user" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

🔑 Getting an API Key: Contact the platform administrator or generate one from your account settings.

Response Format

All responses are returned in JSON format:

{
  "results": [...],
  "count": 10,
  "page": 1
}

Error Handling

Status Code
Meaning

200

Success

201

Created

400

Bad Request - Invalid parameters

401

Unauthorized - Invalid or missing API key

403

Forbidden - Insufficient permissions

404

Not Found - Resource doesn't exist

500

Server Error


API Reference

Core APIs

API
Description
Endpoints

Authentication and session management

20

User profile management

1

Booking and reservation operations

21

Generic CRUD operations for all models

547

Payments & Billing

API
Description
Endpoints

Payment processing

1

ARX payment integration

4

Stripe payment integration

3

Subscription management

5

Payment charges and billing

2

Token rewards system

7

Content & Resources

API
Description
Endpoints

Content articles and blog posts

1

Event management

1

Product catalog

2

Photo uploads and management

2

System & Utilities

API
Description
Endpoints

API health checks

1

API metadata

4

OpenAPI specification

1

Content moderation

2

User onboarding flows

1

Other APIs

API
Description
Endpoints

Accounting operations

1

Custom actions

1

Email notifications

1

Analytics and metrics

1

Paygrid integration

1

Governance proposals

6

Reports generation

1

Sales operations

1

TOC Online integration

1

Token operations

4

Webinar management

1


Data Models

See schemas.md for complete documentation of all data models including:

  • Booking - Accommodation and event reservations

  • Event - Community events and gatherings

  • User - User profiles and authentication

  • Listing - Accommodation listings

  • Product - Products for sale

  • Ticket - Event tickets

  • And many more...


Common Patterns

Pagination

Most list endpoints support pagination:

Parameter
Type
Default
Description

limit

integer

20

Number of results per page

page

integer

1

Page number

Filtering

Filter results using query parameters:

Sorting

Sort results by any field:

Use - prefix for descending order.

Field Selection

Select specific fields to reduce response size:


Rate Limiting

API requests are rate-limited to ensure fair usage. If you exceed the limit, you'll receive a 429 Too Many Requests response.


Need Help?

  • 📖 Interactive API: Swagger UIarrow-up-right

  • 💬 Support: Contact the platform team

  • 🐛 Found a bug? Report issues through the appropriate channels


This documentation is auto-generated from the OpenAPI specification.

Last updated