Settings API

The Settings API provides access to your business configuration, locations, operating hours, and email domain settings.

What Settings Are Available?

The Settings API exposes:

Endpoint	Data Provided
Settings	Business info, localization, enabled features
Locations	Physical locations (stores, pickup points)
Rental Hours	Operating hours and booking constraints
Seasons	Pricing seasons for seasonal rates
Custom Fields	Custom field definitions for extending entities
Policies	Cancellation and rescheduling policies
Taxes	Tax rules and rates
Rate Categories	Participant types for experience pricing (Adult, Child, etc.)
Email Domain	Custom email domain for branded transactional emails

Settings Structure

Settings
├── Business Info
│   ├── Name, email, phone
│   ├── Website
│   └── Business number (ABN, EIN)
├── Localization
│   ├── Timezone
│   ├── Currency
│   ├── Date format
│   └── Country
├── Features (enabled/disabled)
│   ├── Rentals
│   ├── Experiences
│   ├── POS
│   ├── Waivers
│   ├── Surveys
│   └── Bundles
└── Booking Settings
    ├── Customer details required
    ├── Default status
    └── Booking prefix

Locations

Locations represent your physical presence:

Location
├── Name (e.g., "Main Store", "Beach Kiosk")
├── Address (full address details)
├── Contact (phone, email)
└── is_default (primary location flag)

Rental Hours

Operating schedule and booking rules:

Rental Hours
├── Operating Hours (per day of week)
│   └── open, close, closed flag
├── Pickup Times (available slots)
├── Return Times (available slots)
└── Time Constraints
    ├── min_rental_notice_hours
    ├── same_day_bookings
    └── advance_booking_days

API Endpoints

Mostly Read-Only

Most Settings API endpoints are read-only. The Email Domain endpoints support full CRUD operations via the API.

Method	Endpoint	Description	Scope Required
`GET`	/v1/settings	Get business settings	`settings:read`
`GET`	/v1/settings/locations	List all locations	`settings:read`
`GET`	/v1/settings/locations/{id}	Get a single location	`settings:read`
`GET`	/v1/settings/rental-hours	Get operating hours	`settings:read`
`GET`	/v1/settings/seasons	Get pricing seasons	`settings:read`
`GET`	/v1/settings/custom-fields	Get custom field definitions	`settings:read`
`GET`	/v1/settings/policies	Get cancellation policies	`settings:read`
`GET`	/v1/settings/taxes	Get tax rules	`settings:read`
`GET`	/v1/settings/rate-categories	List rate categories	`settings:read`
`GET`	/v1/settings/rate-categories/{id}	Get a single rate category	`settings:read`
`GET`	/v1/email-domain	Get email domain configuration	`settings:read`
`POST`	/v1/email-domain	Create/verify email domain	`settings:write`
`POST`	/v1/email-domain/check-status	Refresh verification status	`settings:write`
`DELETE`	/v1/email-domain	Remove email domain	`settings:write`
`PATCH`	/v1/email-domain/toggle	Enable/disable email domain	`settings:write`

Common Use Cases

Configuring Your Integration

Fetch settings to configure your integration correctly:

curl "https://app.equipdash.com/api/v1/settings" \
  -H "Authorization: Bearer YOUR_API_KEY"

Use the returned timezone and currency to format data appropriately.

Building a Location Selector

Fetch locations for a pickup point dropdown:

curl "https://app.equipdash.com/api/v1/settings/locations" \
  -H "Authorization: Bearer YOUR_API_KEY"

Displaying Available Hours

Get operating hours to show customers when they can pick up/return:

curl "https://app.equipdash.com/api/v1/settings/rental-hours" \
  -H "Authorization: Bearer YOUR_API_KEY"

Key Settings for Integrations

When building an integration, pay attention to:

Setting	Why It Matters
`timezone`	Convert all dates to this timezone for display
`currency`	Format prices with correct currency symbol
`date_format`	Display dates in the expected format
`min_rental_notice_hours`	Prevent bookings too close to now
`advance_booking_days`	Limit how far ahead customers can book

Bookings - Use settings for booking validation
Staff - Staff can be assigned to locations

Customer pickup times

The rentals settings area accepts rental_customer_start_time_mode as every_15_minutes, every_half_hour, or on_the_hour. Each option offers customer pickup times within the supplier's opening hours. Default pickup and return times remain separate settings. Custom lists of exact start times are configured in the product.

What Settings Are Available?​

Settings Structure​

Locations​

Rental Hours​

API Endpoints​

Common Use Cases​

Configuring Your Integration​

Building a Location Selector​

Displaying Available Hours​

Key Settings for Integrations​

Related Resources​

Customer pickup times​