> For the complete documentation index, see [llms.txt](https://docs.equalto.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.equalto.com/rest-api/reading-updating-a-workbook.md).

# Reading / updating a workbook

{% openapi src="<https://sheets.equalto.com/schema>" path="/api/v1/workbooks" method="get" %}
<https://sheets.equalto.com/schema>
{% endopenapi %}

{% openapi src="<https://sheets.equalto.com/schema>" path="/api/v1/workbooks/{workbook\_id}/sheets" method="get" %}
<https://sheets.equalto.com/schema>
{% endopenapi %}

{% openapi src="<https://sheets.equalto.com/schema>" path="/api/v1/workbooks/{workbook\_id}/sheets" method="post" %}
<https://sheets.equalto.com/schema>
{% endopenapi %}

{% openapi src="<https://sheets.equalto.com/schema>" path="/api/v1/workbooks/{workbook\_id}/sheets/{sheet\_index}" method="get" %}
<https://sheets.equalto.com/schema>
{% endopenapi %}

<mark style="color:orange;">`PUT`</mark> `/api/v1/workbooks/{workbook_id}/sheets/{sheet_index}`

Rename a sheet in a workbook.

#### Path Parameters

| Name                                           | Type    | Description |
| ---------------------------------------------- | ------- | ----------- |
| workbook\_id<mark style="color:red;">\*</mark> | String  |             |
| sheet\_index<mark style="color:red;">\*</mark> | integer |             |

#### Request Body

| Name                                        | Type   | Description    |
| ------------------------------------------- | ------ | -------------- |
| new\_name<mark style="color:red;">\*</mark> | String | New sheet name |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}
{% endtabs %}

{% openapi src="<https://sheets.equalto.com/schema>" path="/api/v1/workbooks/{workbook\_id}/sheets/{sheet\_index}" method="delete" %}
<https://sheets.equalto.com/schema>
{% endopenapi %}

{% openapi src="<https://sheets.equalto.com/schema>" path="/api/v1/workbooks/{workbook\_id}/sheets/{sheet\_index}/cells/{row}/{col}" method="get" %}
<https://sheets.equalto.com/schema>
{% endopenapi %}

<mark style="color:orange;">`PUT`</mark> `/api/v1/workbooks/{workbook_id}/sheets/{sheet_index}/cells/{row}/{col}`

Update cell data.

You must specify either `value` or `input`, but not both.

#### Path Parameters

| Name                                           | Type    | Description |
| ---------------------------------------------- | ------- | ----------- |
| workbook\_id<mark style="color:red;">\*</mark> | String  |             |
| sheet\_index<mark style="color:red;">\*</mark> | integer |             |
| row<mark style="color:red;">\*</mark>          | integer |             |
| col<mark style="color:red;">\*</mark>          | integer |             |

#### Request Body

| Name  | Type   | Description                                                                                               |
| ----- | ------ | --------------------------------------------------------------------------------------------------------- |
| input | String | Assign value to cell, with similar semantics to when a user manually enters a value in a spreadsheet cell |
| value | String | Assign value to cell                                                                                      |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}
{% endtabs %}

{% openapi src="<https://sheets.equalto.com/schema>" path="/api/v1/workbooks/{workbook\_id}/xlsx" method="get" %}
<https://sheets.equalto.com/schema>
{% endopenapi %}