Getting Started

API Getting Started

The FreePas API is a RESTful API that allows you to programmatically interact with your events, guests, and analytics data. This guide will help you get started with making your first API request.

Base URL

https://api.freepas.com/api/v1

Quick Start

1. Get Your API Key

Navigate to your dashboard settings and generate an API key. Keep this key secure and never commit it to version control.

2. Make Your First Request

Here's an example using cURL to list your events:

curl -X GET "https://api.freepas.com/api/v1/events" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID" \
  -H "Content-Type: application/json"

Authentication

All API requests require authentication using JWT tokens. Include your access token in the Authorization header:

Authorization: Bearer YOUR_ACCESS_TOKEN

Request Headers

All requests should include the following headers:

• Authorization - Your JWT access token
• X-Tenant-ID - Your organization/tenant ID
• Content-Type - application/json

Response Format

All responses are returned in JSON format with the following structure:

{
  "success": true,
  "data": { ... },
  "message": "Operation successful"
}

Rate Limiting

API requests are rate-limited per endpoint. Rate limit information is included in response headers:

• X-RateLimit-Limit - Maximum requests per window
• X-RateLimit-Remaining - Remaining requests in current window
• X-RateLimit-Reset - Time when the rate limit resets (Unix timestamp)

Next Steps

• Explore the Authentication documentation
• Learn about Events API endpoints
• Check out our Interactive API Documentation