Fetch a single resource.

GEThttps://app.softsolz.uk/api/v1/services/appointments/resources/{id}

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

idstringrequired

Headers

Authorizationstringrequired

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

Response

Response Body

idintegerUnique identifier.

kindstringstaff, contractor, room, equipment, vehicle, team, or your own word such as chair or studio.

namestringDisplay name.

emailstring | nullEmail address.

phonestring | nullPhone number in international format.

timezonestring | nullIANA timezone, for example Europe/London.

skillsarray of stringsSkills this resource holds, used for matching.

capacityintegerPlaces available. 1 is one-to-one; above 1 enables group booking.

is_activebooleanWhether this record is in use.

created_atstringWhen the record was created.

updated_atstringWhen the record was last changed. Round-trip as expected_updated_at to guard against stale writes.

Request

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

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

const result = await client.appointments.getResource('<id>');
console.log(result);

Credentials

Authorization

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

Response · 200

{
  "data": {
    "id": 0,
    "kind": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "timezone": "string",
    "skills": [],
    "capacity": 0,
    "is_active": true,
    "created_at": "string",
    "updated_at": "string"
  }
}