Skip to main content
The Companies API lets you query scheduling availability for a company. Use it to populate a time picker in your checkout flow whenever appointment scheduling is required. All endpoints are relative to the base URL https://yourcompany.pay.nova.money/api/v1.

List available schedules

Retrieve the available appointment time slots for a company on a specific date. The response is a list of HH:MM strings representing times that are open for booking.

Path parameters

integer
required
The numeric ID of the company whose scheduling availability you want to query.

Query parameters

date
The date to check availability for, in YYYY-MM-DD format (e.g., 2024-09-15).

Response

An array of available time slot strings in HH:MM format (24-hour clock). An empty array is returned when any of the following conditions apply:
  • No date or id parameter was provided.
  • The requested date is in the past.
  • The company has no schedule configured for the weekday of the requested date.

Example request and response

This endpoint is typically used when a checkout page has require_scheduling: true configured. Fetch available slots when the customer lands on the page, then render a time picker with the returned values so the customer can choose their preferred appointment time.
Once the customer selects a time slot, combine it with the chosen date and pass the result as scheduled_at (ISO 8601 datetime) in your payment request body — for example:
Always re-fetch available slots just before the customer confirms their booking. Slots can be claimed by other customers in the time between your initial fetch and the final submission.