API & Developer Access | Guidewinds

API Overview

The Guidewinds API gives you programmatic access to your bookings, anglers, trips, and availability data. Use it to build custom integrations, sync with your CRM, or automate repetitive tasks.

The API follows REST conventions with JSON request and response bodies, standard HTTP status codes, and predictable resource-based URLs.

Plan Requirement

API access is available on the Enterprise plan. Contact us at bentley@guidewinds.com for developer documentation and onboarding.

Authentication

All API requests require authentication using an API key. Generate and manage your keys from the dashboard:

Go to Dashboard → Settings → API
Click "Generate API Key"
Give the key a descriptive name (e.g., "CRM Sync")
Copy the key immediately — it won't be shown again
Include it in requests as a Bearer token: Authorization: Bearer your-api-key

Keep Keys Secret

API keys grant full access to your account data. Never expose them in client-side code, public repositories, or browser requests. Use server-side calls only.

Rate Limits

To ensure platform stability, API requests are rate-limited per key:

Standard limit: 100 requests per minute per API key
Burst limit: Up to 20 requests per second for short bursts
Webhook deliveries: Not counted against your rate limit

Rate limit headers are included in every response: X-RateLimit-Remaining and X-RateLimit-Reset. If you exceed the limit, you'll receive a 429 Too Many Requests response.

Pro Tip

Use webhook events instead of polling to stay well within rate limits. Webhooks push data to you in real time, so you don't need to repeatedly check for changes.

Core API Resources

The API exposes these primary resources:

Bookings: Create, read, update, and cancel bookings. Includes guest details, payment status, and add-ons.
Anglers: Manage your angler database. Search, create, update profiles, and view booking history.
Trips: List and manage your trips, including pricing, duration, and capacity settings.
Availability: Query available time slots for any trip and date range.
Payments: View payment records, refund status, and deposit details.

Consistent with Your Dashboard

Everything you see in the dashboard is available through the API. Changes made via the API are immediately reflected in the dashboard and vice versa.

Webhook Setup

Webhooks notify your server when events happen in Guidewinds. Instead of polling for changes, your endpoint receives a POST request with event data in real time.

Go to Dashboard → Settings → API → Webhooks
Click "Add Webhook Endpoint"
Enter your HTTPS endpoint URL
Select which events to subscribe to
Save and test with a sample event

Available Events

booking.created — A new booking is confirmed
booking.updated — Booking details changed
booking.cancelled — A booking was cancelled
payment.received — Payment or deposit collected
customer.created — New angler added
availability.updated — Schedule or capacity changed

Pro Tip

Each webhook delivery includes a signature header for verification. Always validate the signature on your server to ensure the request came from Guidewinds.

Common Use Cases

CRM sync: Push new anglers and bookings to Salesforce, HubSpot, or your custom CRM
Accounting integration: Automatically create invoices in QuickBooks or Xero when bookings are confirmed
Custom notifications: Trigger SMS, Slack messages, or emails from your own systems when events occur
Reporting: Pull booking and revenue data into your BI tools for custom dashboards
Mobile apps: Build a custom mobile experience that reads from and writes to Guidewinds

What's Next?

Embed Widget — Add a booking widget to your existing website
Analytics — Track your booking performance