> ## Documentation Index
> Fetch the complete documentation index at: https://docs.plec-it.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Introduction

> How to use the PLEC API (dry-run by default), auth, and playground tips.

## Overview

This API powers the PLEC platform (bookings, listings, payments, messaging, and integrations).\
Use the **API reference** tab to explore endpoints and try requests in the interactive playground.

## Dry run (default)

All endpoints support **dry run** mode.

* When **dryRun=true**, the request is validated and executed in “no side effects” mode.
* When **dryRun=false** (or omitted, depending on the endpoint), the request performs the real action.

<Info>
  If you’re using the playground, keep **dryRun=true** while exploring so you don’t accidentally create, update, or delete real data.
</Info>

## Authentication

Most endpoints require a Bearer token:

* Send an `Authorization` header in the form: `Bearer <token>`
* In the playground, use the **Authorization** input to paste the token once, then it will be reused for other calls.

<Note>
  Some endpoints are public (no auth). If an endpoint returns **401 Unauthorized**, you’re missing a token or the token doesn’t have access.
</Note>

## Using the Playground

The playground sends real HTTP requests to the selected server, but with **dryRun=true** you should not trigger side effects.

### Quick checklist

* ✅ Ensure `dryRun=true` is present (query param or request body, depending on the endpoint)
* ✅ Prefer `GET` requests when exploring
* ✅ Keep Bearer auth set for protected endpoints

<Warning>
  Dry run only works if the endpoint honors it. If you see side effects while `dryRun=true`, treat that as a bug and avoid using the playground for that route until fixed.
</Warning>

## OpenAPI Source

The API reference is generated from the OpenAPI specification committed in this repo:

<Card title="OpenAPI Specification" icon="file-lines" href="/api-reference/openapi.json">
  View the OpenAPI JSON used by Mintlify
</Card>
