v1v2
← All Guides

Welcome to the Avvail Guest Book API! Follow these steps to begin integrating with our reservation services.

1. Obtain Credentials

Contact our support team or your account representative to request client credentials (Client ID and Secret) for OAuth 2.0 Client Credentials flow. We'll provide sandbox credentials first, allowing you to test without affecting real data.

2. Test in Sandbox

Use the provided Client ID and Client Secret to request an access token from the sandbox token URL:

https://sandbox.auth.avvail.com/oauth/token

Send all API requests to the sandbox base URL:

https://sandbox.api.avvail.com

Use the access token as a Bearer token in the Authorization header. See Authentication for full details on the token exchange flow.

Make Your First Request

List your venues:

curl https://sandbox.api.avvail.com/v2/venues \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Book a Reservation

v2 uses an option-driven booking flow. Query availability, optionally create a hold, then confirm the reservation:

Query availability:

curl "https://sandbox.api.avvail.com/v2/availability?venue_id=VENUE_UUID&date=2025-06-15&party_size=2" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Create a reservation from an availability option:

curl -X POST https://sandbox.api.avvail.com/v2/reservations \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "option_id": "opt_abc123xyz",
    "guest": {
      "email": "jane@example.com",
      "first_name": "Jane",
      "last_name": "Doe",
      "mobile_number": "+15555555555"
    },
    "special_requests": "Window seat preferred"
  }'

For high-demand periods, use a hold to lock capacity for 10 minutes before confirming. See the API v2 Migration Guide for the full hold workflow.

3. Explore the API

  • Endpoints: Browse venues with /v2/venues, query availability with /v2/availability, and create reservations with /v2/reservations.
  • Filtering & Pagination: Learn how to filter by date, status, or other parameters in Advanced Usage.
  • Error Handling: The API returns RFC 7807-style error responses. Refer to Error Handling for details.
  • Versioning: All routes begin with /v2/. See the Migration Guide for details on changes from v1.

4. Move to Production

Once everything works in sandbox, switch your token URL to:

https://auth.avvail.com/oauth/token

Send API requests to the production base URL:

https://api.avvail.com

Use production credentials provided by Avvail.

5. Stay Informed

  • Watch for sunset dates and deprecations in API response headers.
  • For questions or issues, reach out via email at support@avvail.com.

Next Steps