Get Worksheet

Retrieve the properties and relationships of worksheet object.

Prerequisites

The following scopes are required to execute this API:

HTTP request

GET /workbook/worksheets(<id|name>)

Optional query parameters

This method supports the OData Query Parameters to help customize the response.

Request headers

Name Description
Authorization Bearer

Request body

Do not supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and Worksheet object in the response body.

Example

Request

Here is an example of the request.

GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/worksheets(<id|name>)
Response

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 100

{
  "id": "id-value",
  "position": 99,
  "name": "name-value",
  "visibility": "visibility-value"
}