Skip to main content

​
API Reference

PilotFlows provides a comprehensive REST API that allows you to integrate with our platform, automate workflows, and build custom applications.
API Access: API access is available for organization accounts. Contact support to enable API access for your organization and obtain API credentials.

​
Overview

The PilotFlows API follows RESTful principles and uses standard HTTP methods. All API requests require authentication using API keys or OAuth tokens.

​
Base URL

https://api.pilotflows.com/v1

​
Authentication

API requests must include authentication credentials in the request headers: 
curl -X GET "https://api.pilotflows.com/v1/organizations" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

​
Getting Started

1

Request API Access

Contact support to enable API access for your organization account. Provide your organization details and intended use case.
2

Obtain API Credentials

Once approved, you’ll receive:
  • API Key (for server-to-server authentication)
  • OAuth credentials (for user-facing applications)
  • Organization ID
3

Review API Documentation

Explore available endpoints and understand request/response formats. All endpoints are organization-scoped.
4

Start Integrating

Begin with simple read operations, then expand to write operations as needed.

​
API Endpoints

The API is organized into logical resource groups:

Organizations

Manage organization data, members, and settings

Flight Logs

Create, read, update, and delete flight log entries

Aircraft

Manage aircraft and simulator records

Members

Manage organization members and roles

Accounting

Access invoices, expenses, and financial data

Calendar

Manage events and schedules

​
Rate Limits

API requests are subject to rate limits to ensure fair usage:
  • Standard Plans: 1,000 requests per hour
  • Organization Plans: 5,000 requests per hour
  • Enterprise Plans: Custom limits
Rate limit headers are included in all responses:
  • X-RateLimit-Limit: Maximum requests allowed
  • X-RateLimit-Remaining: Remaining requests in current window
  • X-RateLimit-Reset: Time when limit resets

​
Response Formats

All API responses use JSON format. Successful responses include the requested data: 
{
  "data": {
    "id": "123",
    "type": "flight_log",
    "attributes": {
      "date": "2024-01-15",
      "aircraft": "N12345",
      "duration": 1.5
    }
  }
}
Error responses include error details: 
{
  "error": {
    "code": "validation_error",
    "message": "Invalid date format",
    "details": {
      "field": "date",
      "issue": "Date must be in YYYY-MM-DD format"
    }
  }
}

​
Common Use Cases

Automatically sync flight logs from external systems or devices. Use POST endpoints to create new entries.
Retrieve flight data and generate custom reports or analytics beyond what’s available in the web interface.
Connect PilotFlows with your existing scheduling or booking systems to automatically create flight log entries.
Use the API to build custom mobile applications that interact with PilotFlows data.

​
Webhooks

PilotFlows can send webhooks to your endpoints when certain events occur:
  • Flight log created or updated
  • Member added or removed
  • Invoice created or paid
  • Aircraft status changed
  • And more
Webhook configuration is available in organization settings. Contact support to enable webhooks for your organization.

​
SDKs and Libraries

Community-maintained SDKs are available for popular programming languages:
  • JavaScript/TypeScript: Available via npm
  • Python: Available via pip
  • Ruby: Available via gem
SDKs are maintained by the community. For official support, use the REST API directly or contact support for assistance.

​
Support and Resources

API Documentation

Complete interactive API documentation

Contact Support

Get help with API integration

Community Forum

Connect with other developers

Status Page

Check API status and uptime

​
Next Steps

  1. Request API Access - Contact support to enable API for your organization
  2. Review Documentation - Explore available endpoints and examples
  3. Test Integration - Start with read operations to understand data structures
  4. Build Your Integration - Implement your use case using the API
API Access Required: Full API documentation and credentials are only available after API access is enabled for your organization. Contact support to get started.