v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Amenities

Retrieve all amenities

Retrieve all amenities.

Required scopes: flex.space.amenities.read

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

Path parameters

orgSlugstring required

organization slug

Query parameters

_idstring

Example:6080186f490fcf6e0547ec57

Filter by the _id of the amenity.

titlestring

Example:Amenity 1

Filter by the title of the amenity.

createdAtstring

Example:createdAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Support date comparison filters: $gt, $gte, $lt, $lte

modifiedAtstring

Example:modifiedAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Filter by the modified date. Supports date comparison filters: $gt, $gte, $lt, $lte

$selectstring

Example:recipient,sender

Select fields to return

$cursorNextstring

$cursorPrevstring

$limitnumber

Response

rangeStartnumber

rangeEndnumber

cursorNextstring

cursorPrevstring

Example response

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