Find bookable slots for an appointment type over a date range.

GEThttps://app.softsolz.uk/api/v1/services/appointments/availability

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Query Params

type_idintegerrequired

Appointment type to check. Required.

fromstringrequired

Start of the search range, ISO date or timestamp. Required.

tostringrequired

End of the search range, ISO date or timestamp. Required.

resource_idinteger

Restrict to one resource. Omit to search every qualifying resource.

timezonestring

IANA timezone to render slots in. Defaults to the workspace timezone.

Response

Response Body

timezonestringIANA timezone, for example Europe/London.

slotsarray of objectsBookable slots in the requested range.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.appointments.getAvailability({});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": {
    "timezone": "string",
    "slots": []
  }
}