Resources

Get a resource by id

The same resource as under its location, found from its id. For a caller that holds an id and not the location it belongs to. The answer carries locationId.

get/v1/resources/{resourceId}

Request

  • Base URL: https://api.cliento.com
  • URL: https://api.cliento.com/v1/resources/{resourceId}
  • Auth: HTTP bearer

Path parameters

resourceIdstring required

Response

OK

createdAtstring date-time

When it was created, in UTC. Left out when that is not known.

groupIdstring

The group the resource is listed under. Left out for a deleted resource.

idstring required
locationIdstring required
namestring required

The name staff see in the calendar.

onlineBookingEnabledboolean required

Whether the resource is open for online booking at all. Which services customers may book with it is on the resource service.

onlineNamestring

The name customers see in online booking, when it differs.

pausedUntilstring

For a paused resource: the last day of the pause.

statusstring required

active, paused or deleted. A paused resource is paused for billing: it keeps its bookings but takes no new online bookings. A deleted resource is left out of the list but still answers by id, since earlier bookings refer to it. The status is not changed through the API. More values may be added.

typestring required

What kind of thing it is, as one lower-case word such as person or room. Set when the resource is created. The list is open, so accept a value you do not know.

updatedAtstring date-time required

When it last changed, in UTC.

Example response

{
  "createdAt": "2026-03-02T08:15:00Z",
  "groupId": "rgr_5Jk9wQe2Ty6Nb3Vx8MzLcA",
  "id": "res_4Hn7pQw2Zt9Lk3Vd6XyRbA",
  "locationId": "loc_4fK9xQ2mLr8TzB1vNc7HdW",
  "name": "Anna",
  "onlineBookingEnabled": true,
  "onlineName": "Anna L.",
  "pausedUntil": "2026-12-31",
  "status": "active",
  "type": "person",
  "updatedAt": "2026-10-12T09:24:31.512Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.