OFofficernd
Resources

Get resource status

Get the status and ownStatus for a specific resource

Required scopes: flex.space.resources.read

get/api/v2/organizations/{orgSlug}/resources/{resourceId}/status

Request

  • Base URL
    https://app.officernd.com
  • URL
    https://app.officernd.com/api/v2/organizations/{orgSlug}/resources/{resourceId}/status
  • Auth
    OAuth 2
    Authorization code: https://identity.officernd.com/auth/authorize
    Client credentials
    Token URL: https://identity.officernd.com/auth/token scopes: flex.space.resources.read

Path parameters

resourceIdstring required

resource id

orgSlugstring required

organization slug

Response

_idstring

The unique identifier of the resource.

statusstring

The current status of the resource for today. Possible values include "available", "occupied", "partially_occupied", "reserved", "available_soon", "unavailable" and "hotdesk" (for hot desks). For assignable parent resources with children, this reflects the overall status including children; assignable resources use today in UTC. Bookable-only resource types (e.g. meeting rooms) return "available" or "unavailable" based on their own availability window for today in their location's timezone; their children are not considered.

ownStatusstring

The resource's own status. Always present. For parent resources with children (e.g. private offices with office desks), it excludes the children; for office desks (desk_tr), it excludes the effect of the parent office. Equals status for simple and bookable-only resources. Example: A private office (team_room) with two office desks (desk_tr) where one desk is occupied would have ownStatus="available" (the office itself is not directly occupied) and status="partially_occupied" (accounting for the occupied child desk).

Example response

{
  "_id": "603dfbc260f4054084125d39",
  "status": "available",
  "ownStatus": "available"
}

Changes

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