SAsalesforce
rooms

GET /rooms

Changed on

Request

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

Query parameters

namestring

Filter rooms by name

activeboolean

Filter rooms by active flag

typestring

Filter room by roomType

originstring

Filter rooms by origin

createdAtstring

Filter by time period when rooms were created.

updatedAtstring

Filter by time period when rooms were updated.

sortstring

Specify the sort order using a field name, e.g. '...?sort=name'. Prepend the field name with a minus sign to specify descending order, e.g. '...?sort=-name'.

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 all rooms

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