SAsalesforce
rooms

Get room

Changed on
get/rooms/{key}

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/rooms/{key}
  • Auth
    API key in header Authorization

Path parameters

keystring required

The id or name of the room to retrieve

Query parameters

activeboolean

Get rooms depending on its active tag

limitinteger

Maximum number of records to return in the response; also useful for pagination in the UI.

offsetinteger

Offset for paginating the response.

Response

Success, returns specified room

idinteger

The room number of the specified room

namestring

The unique readable name for the room

activeboolean

Flag for whether the room is still active or closed

typestring

The roomType being used in the specified room

createdBystring

Id of the User who created this room.

originstring

Tracks where refocus room was created from

Changes