WSD User API

The WSD User API is a Scripted REST API which returns the authenticated user's workplace context, including their assigned workspace location, in-office presence schedule, collaborators, and past and future reservations.

This WSD User is featured with the Workplace Service Delivery (WSD) Reservation product and provides a single-call entry point for initializing the reservation booking experience with all relevant user data. This API sits within the Workplace Service Delivery Reservation (com.sn_wsd_rsv) plugin and serves as the entry point for surfacing a user's complete workplace identity and history.

An authenticated user is someone who is logged in or whose credentials are included in the API request.

Common use cases:

• Reservation portal initialization: Load a user's home location, schedule, and booking history in a single call when opening a workplace app or portal.
• Custom mobile or web apps: Fetch all the user context without stitching together multiple table API calls,for example when building front-end reservation experiences.
• In-office presence tracking: Identify which employees are scheduled to be in-office on a given day.

Requirements

The WSD User API requires:

• At least one user record must exist with the sn_wsd_core.workplace_user role.
• The Workplace Service Delivery Concierge (com.sn_wsd_concierge), Workplace Service Delivery Core (com.sn_wsd_core), and Workplace Service Delivery Reservation (com.sn_wsd_rsv) plugins to be active.

Related APIs

The WSD User API belongs to a family of APIs all under the sn_wsd_rsv namespace that together support the full reservation lifecycle:

• WSD Search API: Find available reservable spaces based on location, time, and capacity criteria.
• WSD Reservation API: Create reservations and manage check-in/check-out.
• WSD Reservable Module API: Retrieve the booking rule configurations that govern what users can reserve and how.

Parent Topic:REST API reference

WSD User - GET /api/sn_wsd_rsv/v1/user/context

Retrieves the authenticated user's workplace context, including their assigned workplace location, presence schedule, collaborators, and past and future reservations.

Use this endpoint to initialize a reservation experience by loading all relevant user context in a single call. Collaborator data is optionally included when the com.sn_wsd_concierge plugin is active.

URL format

Versioned URL: /api/sn_wsd_rsv/{api_version}/user/context

Default URL: /api/sn_wsd_rsv/user/context

Supported request parameters

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Response body parameters (JSON or XML)

"result": {
  "collaborators": [Array],
  "reservations": {Object},
  "schedule": {Object},
  "workplace_location": {Object}
}

"collaborators": [
 {
  "exceptions": "Array",
  "name": "String",
  "routine": "Object",
  "sys_id": "String", 
 }
]

"exceptions": [
 {
  "date": "String",
  "in_office": Boolean,
  "location": "String",
  "origin": "String",
  "sys_id": "String"
 }
]

"routine": {
  "monday": Boolean,
  "tuesday": Boolean,
  "wednesday": Boolean,
  "thursday": Boolean, 
  "friday": Boolean,
  "saturday": Boolean,
  "sunday": Boolean
}

"reservations": {
  "past": [Array],
  "future": [Array]
}

"future": [
 {
  "sys_id": "String",
  "number": "String",
  "start": "String",
  "end": "String",
  "state": "String",
  "subject": "String,
  "location": {Object},
  "building": {Object}
 }
]

"building": {
 "name": "String",
 "sys_id": "String"
}

"location": {
  "sys_id": "String",
  "name": "String"
}

"past": [
 {
  "sys_id": "String",
  "number": "String",
  "start": "String",
  "end": "String",
  "state": "String",
  "subject": "String,
  "location": {Object},
  "building": {Object}
 }
]

"location": {
  "sys_id": "String",
  "name": "String"
}

"schedule": {
  "exceptions": [Array],
  "routine": {Object}
}

"exceptions": [
{
  "sys_id": "sys_id", 
  "date": "String", 
  "in_office": Boolean, 
  "origin": "String", 
  "location": "String" 
 }
]

"routine": {
  "monday": Boolean,
  "tuesday": Boolean,
  "wednesday": Boolean,
  "thursday": Boolean, 
  "friday": Boolean,
  "saturday": Boolean,
  "sunday": Boolean
}

"workplace_location": {
  "building": {Object},
  "campus": {Object},
  "floor": {Object},
  "name": "String",
  "sys_id": "String"
}

"building": {
  "name": "String",
  "sys_id": "String"
}

"campus": {
  "name": "String",
  "sys_id": "String"
}

"floor": {
  "name": "String",
  "sys_id": "String"
}

cURL request

The following example retrieves the authenticated user's full workplace context, including collaborators, 1 month of past reservations, and 6 months of future reservations.

This example uses Basic authentication. If your instance uses SSO, use a bearer token or session cookie instead. See the 'Headers' table for details.

curl "https://<instance>.service-now.com/api/sn_wsd_rsv/v1/user/context?include=collaborators&past_reservations_months=1&future_reservations_months=6" \
  --request GET \
  --header "Accept: application/json" \
  --user "username:password"

Response body.

{
  "result": {
    "workplace_location": {
      "sys_id": "a1b2c3d4e5f6g7h8",
      "name": "Desk 42 - Floor 3",
      "floor": { "sys_id": "f1a2b3c4", "name": "Floor 3" },
      "building": { "sys_id": "b1c2d3e4", "name": "HQ Building A" },
      "campus": { "sys_id": "c1d2e3f4", "name": "Main Campus" }
    },
    "schedule": {
      "routine": {
        "monday": true, "tuesday": true, "wednesday": false,
        "thursday": true, "friday": false, "saturday": false, "sunday": false
      },
      "exceptions": []
    },
    "collaborators": [
      {
        "sys_id": "d4e5f6g7",
        "name": "Jane Smith",
        "routine": { "monday": true, "tuesday": false, "wednesday": true,
                     "thursday": true, "friday": false, "saturday": false, "sunday": false },
        "exceptions": []
      }
    ],
    "reservations": {
      "past": [
        {
          "sys_id": "r1e2s3v4",
          "number": "RSV0001234",
          "start": "2026-04-01 09:00:00",
          "end": "2026-04-01 17:00:00",
          "state": "completed",
          "subject": "Team standup desk",
          "location": { "sys_id": "l1o2c3", "name": "Desk 42" },
          "building": { "sys_id": "b1c2d3e4", "name": "HQ Building A" }
        }
      ],
      "future": []
    }
  }
}