v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Amenities

Get an amenity

Get the amenity with id = {amenityId}.

Required scopes: flex.space.amenities.read

get/api/v2/organizations/{orgSlug}/amenities/{amenityId}

Path parameters

amenityIdstring required

The id of the corresponding amenity

orgSlugstring required

organization slug

Response

_idstring

The _id of the amenity.

titlestring

The name of the amenity.

iconstring

The icon chosen for the amenity, it's best to take a look at the UI and see what icons are available.

createdAtstring date-time

The _id of the amenity.

createdBystring

The _id of the amenity.

Example response

{
  "_id": "6080186f490fcf6e0547ec57",
  "title": "Amenity 1",
  "icon": "fa-500px",
  "createdAt": "2021-04-21T18:00:00.000Z",
  "createdBy": "5bbb155174321f100085eac1"
}