### Get Image URL for a Cell (JavaScript SDK)

Source: https://developers.smartsheet.com/api/smartsheet/openapi/cellimages/imageurl

Example using the Smartsheet JavaScript SDK to get a cell image URL. Ensure the SDK is installed and configured with your access token.

```javascript
const SmartsheetClient = require('smartsheet');
const smartsheet = SmartsheetClient.createClient({
  accessToken: 'YOUR_ACCESS_TOKEN'
});

sheetId = 1234567890;
rowId = 123;
cellId = 654;

smartsheet.sheets.getCellImage({
  sheetId: sheetId,
  rowId: rowId,
  cellId: cellId,
  format: 'png'
}).then(function(result) {
  console.log(result.url);
}).catch(function(error) {
  console.error(error);
});
```

--------------------------------

### List Availabilities Response Example

Source: https://developers.smartsheet.com/api/resource_management/openapi/availabilities/deleteavailability

This is an example JSON response schema for listing user availabilities, showing pagination metadata and a data array.

```json
{
  "paging": {
    "per_page": 20,
    "page": 1,
    "previous": null,
    "self": "/api/v1/users/3505944/availabilities?user_id=3505944&page=1",
    "next": null
  },
  "data": [
    { … }
  ]
}
```

--------------------------------

### Example Response for Listing Placeholder Resources

Source: https://developers.smartsheet.com/api/resource_management/openapi/placeholder-resources/createplaceholderresource

This is an example of a successful response (200 OK) when listing placeholder resources for a project. It includes pagination metadata and an empty data array if no resources are assigned.

```JSON
{
  "paging": {
    "per_page": 20,
    "page": 1,
    "previous": null,
    "self": "/api/v1/projects/6929276/placeholder_resources?project_id=6929276&page=1",
    "next": null
  },
  "data": []
}
```

--------------------------------

### Column Index Example

Source: https://developers.smartsheet.com/api/smartsheet/openapi/schemas/pathfoldersonly

Example of a number representing the column's position in the sheet, starting at 0. This is a read-only property.

```json
{
  "index": 0
}
```

--------------------------------

### Example Content-Disposition Header

Source: https://developers.smartsheet.com/api/smartsheet/openapi/sheetsummary/summaryfield

This example demonstrates the required format for the 'Content-Disposition' header when uploading a file, including the filename.

```text
attachment; filename="ProgressReport.docx"
```

--------------------------------

### Get Users Collection

Source: https://developers.smartsheet.com/api/resource_management/getting-started/collections-and-objects.md

Example of how to make a GET request to retrieve a collection of users. Ensure you include the correct Content-Type and authorization headers.

```curl
curl -X GET https://api.rm.smartsheet.com/api/v1/users \
  -H "Content-Type: application/json" \
  -H "auth: TOKEN"
```

--------------------------------

### Example 200 Response Schema for Get Report Path

Source: https://developers.smartsheet.com/api/smartsheet/openapi/reports/deletereport

This is an example of a successful response (200 OK) when retrieving the path of a report. It includes details about the report and its containing workspace.

```json
{
  "reports": [
    { … }
  ],
  "id": 4509918431602564,
  "name": "Sample Workspace",
  "permalink": "https://api.smartsheet.com/workspaces/cpG82pf5v8FPrgFfJrFcrM56xCHVGhmV4P4xcQ71",
  "accessLevel": "ADMIN"
}
```

--------------------------------

### List User Plans Response Example

Source: https://developers.smartsheet.com/api/smartsheet/openapi/users/account

This JSON object shows a typical response when listing user plans, including the lastKey for pagination and an array containing user plan data.

```json
{
  "lastKey": "48569348493401200",
  "data": [
    { … }
  ]
}
```

--------------------------------

### Example Response for Listing Project Tags

Source: https://developers.smartsheet.com/api/resource_management/openapi/tags-per-project/getprojecttags

This is an example JSON response when successfully retrieving tags for a project. It includes the list of tags and pagination metadata.

```json
{
  "data": [
    { … }
  ],
  "paging": {
    "next": null,
    "page": 1,
    "per_page": 20,
    "previous": null,
    "self": "/api/v1/projects/1/tags?project_id=1&per_page=20&page=1"
  }
}
```

--------------------------------

### Get Immediate Workspace Children (Folders)

Source: https://developers.smartsheet.com/api/smartsheet/guides/updating-code/migrate-from-get-workspaces-loadall.md

Retrieve the immediate children of a workspace, specifically filtering for 'folders'. This example shows how to make the initial call to get the first page of children.

```python
last_key = None

response = smart.Workspaces.get_workspace_children(
    workspace_id, children_resource_types=["folders"], last_key=last_key
)
```

--------------------------------

### List User Plans Request Example

Source: https://developers.smartsheet.com/api/smartsheet/openapi/users/account

This cURL command demonstrates how to list plans for a specific user, including pagination parameters and custom headers for integration source tracking.

```curl
curl -i -X GET \
  'https://api.smartsheet.com/2.0/users/{userId}/plans?lastKey=abcDefGhIjKlMnOpQrStUvWxYz&maxItems=100&displayContributorSeatType=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'smartsheet-integration-source: AI,SampleOrg,My-AI-Connector-v2'
```

--------------------------------

### Get Current User - Response Body Example

Source: https://developers.smartsheet.com/api/smartsheet/openapi/users/account

An example of the JSON response body when successfully retrieving the current user's profile. This includes various user attributes and account details.

```json
{
  "id": 48569348493401200,
  "account": {
    "id": 122454719915908,
    "name": "Smartsheet Org"
  },
  "admin": true,
  "alternateEmails": [
    { … }
  ],
  "company": "Smartsheet",
  "customWelcomeScreenViewed": "2020-08-25T12:15:47Z",
  "department": "Engineering",
  "email": "john.doe@smartsheet.com",
  "firstName": "John",
  "groupAdmin": true,
  "jiraAdmin": true,
  "lastLogin": "2020-10-31T12:15:47Z",
  "lastName": "Doe",
  "licensedSheetCreator": true,
  "locale": "en_US",
  "mobilePhone": "555-867-5309",
  "profileImage": {
    "imageId": "u!1!nAtdn5RJB_o!k6_e_3h2R3w!wmYXPek-yVD",
    "height": 1050,
    "width": 1050
  },
  "resourceViewer": true,
  "role": "Software Developer",
  "salesforceAdmin": false,
  "salesforceUser": false,
  "sheetCount": -1,
  "timeZone": "US/Pacific",
  "title": "Senior Software Engineer",
  "workPhone": "844-324-2360",
  "data": [
    { … }
  ]
}
```

--------------------------------

### Example Content-Length Header

Source: https://developers.smartsheet.com/api/smartsheet/openapi/sheetsummary/summaryfield

An example of the 'Content-Length' header, which must be set to the size of the file in bytes.

```text
5463
```

--------------------------------

### Delete Column - JavaScript

Source: https://developers.smartsheet.com/api/smartsheet/openapi/columns/column-delete

Example of deleting a column using the Smartsheet JavaScript SDK. Ensure you have the SDK installed and authenticated.

```javascript
smartsheet.columns.deleteColumn({
  sheetId: sheetId,
  columnId: columnId
}).then(function(column) {
  // Handle success
}).catch(function(error) {
  // Handle error
});
```

--------------------------------

### Get Cross-Sheet Reference cURL Example

Source: https://developers.smartsheet.com/api/smartsheet/openapi/crosssheetreferences/get-crosssheet-reference

This snippet shows how to make a GET request to retrieve a cross-sheet reference using cURL. Ensure you replace placeholder values with your actual sheet ID, cross-sheet reference ID, and API token.

```bash
curl https://api.smartsheet.com/2.0/sheets/{sheetId}/crosssheetreferences/{crossSheetReferenceId} \
-H "Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789"
```

--------------------------------

### Example Placeholder Resource Response

Source: https://developers.smartsheet.com/api/resource_management/openapi/placeholder-resources/createplaceholderresource

This is an example JSON response for a successfully retrieved placeholder resource, including its details and associated assignments.

```json
{
  "id": 4074761,
  "title": "RM Test Placeholder",
  "user_type_id": 0,
  "guid": "1ce497c5-64a2-4a19-9983-6c3c4783f6e8",
  "role": null,
  "discipline": null,
  "location": null,
  "displayName": "RM Test Placeholder",
  "type": "PlaceholderResource",
  "thumbnail": null,
  "abbreviation": null,
  "color": null,
  "created_at": "2025-09-26T18:54:02Z",
  "updated_at": "2025-09-26T18:54:02Z",
  "billrate": -1,
  "assignments": {
    "paging": { … },
    "data": []
  }
}
```

--------------------------------

### Get Row by Row ID (JavaScript)

Source: https://developers.smartsheet.com/api/smartsheet/openapi/rows/row-get

Example of retrieving a specific row from a sheet using its unique row ID in JavaScript.

```JavaScript
const options = {
  method: 'GET',
  url: 'https://api.smartsheet.com/2.0/sheets/{sheetId}/rows/{rowId}',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
  }
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
```

--------------------------------

### Simple Upload Example

Source: https://developers.smartsheet.com/api/smartsheet/openapi/proofs/proofs-get

This example shows how to perform a simple upload to attach a file to a sheet. It details the required headers and how the file content is included in the request body.

```APIDOC
## POST /sheets/{sheetId}/attachments

### Description
Uploads a file as an attachment to a sheet using a simple upload request.

### Method
POST

### Endpoint
`https://api.smartsheet.com/2.0/sheets/{sheetId}/attachments`

### Headers
- **Authorization**: Bearer [YOUR_ACCESS_TOKEN]
- **Content-Disposition**: `attachment; filename="_filename_"` (filename is URL-encoded)
- **Content-Type**: The MIME type of the file (can be blank, Smartsheet will attempt to guess).
- **Content-Length**: The size of the file in bytes.

### Request Body
The binary content of the file to be attached.

### Request Example
```http
POST https://api.smartsheet.com/2.0/sheets/4509093797881732/attachments
Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789
Content-Disposition: attachment; filename="ProgressReport.docx"
Content-Type: application/msword
Content-Length: 5463

< Binary content for file >
```
```

--------------------------------

### Example License Grant Request

Source: https://developers.smartsheet.com/api/smartsheet/openapi/schemas/license_requests_grant_license

This snippet shows a sample JSON payload for requesting to grant a license to a user. It includes the necessary user ID and license information.

```json
{
  "userId": 123457654321,
  "license": {
    "type": "PREMIUM_ASSISTANT",
    "seats": 1
  }
}
```

--------------------------------

### List Proof Discussions Request

Source: https://developers.smartsheet.com/api/smartsheet/openapi/proofs/proofrequest

Example of a cURL request to get a list of proof discussions, including attachments and pagination parameters.

```curl
curl -i -X GET \
  'https://api.smartsheet.com/2.0/sheets/{sheetId}/proofs/{proofId}/discussions?include=attachments&page=1&pageSize=100&includeAll=false' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'smartsheet-integration-source: AI,SampleOrg,My-AI-Connector-v2'
```

--------------------------------

### Delete Dashboard (JavaScript SDK)

Source: https://developers.smartsheet.com/api/smartsheet/openapi/dashboards/delete-sight

Example of deleting a dashboard using the Smartsheet JavaScript SDK. This requires the SDK to be installed and authenticated.

```javascript
smartsheet.dashboards.deleteDashboard({ id: dashboardId })
  .then(function(result) {
    // success
  })
  .catch(function(error) {
    // error
  });

```

--------------------------------

### Rate Limit Headers Example

Source: https://developers.smartsheet.com/api/resource_management/getting-started/throttling-and-rate-limiting.md

These headers indicate the current rate limit status. X-RateLimit-Reset provides the UTC epoch seconds when the rate limit window resets.

```text
X-RateLimit-Limit:120
X-RateLimit-Remaining:0
X-RateLimit-Reset:1482966442
```

--------------------------------

### Get Dashboard Publish Status cURL Example

Source: https://developers.smartsheet.com/api/smartsheet/openapi/dashboards/delete-sight

This cURL command demonstrates how to request the publish status of a specific dashboard using its ID.

```curl
curl https://api.smartsheet.com/2.0/sights/{sightId}/publish \
-H "Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789"
```

--------------------------------

### Server Info Formatting - Defaults Example

Source: https://developers.smartsheet.com/api/smartsheet/openapi/schemas/rowfiltercriteria

Example of default formatting descriptor for unset values.

```json
",,1,1,,,,,,,,,,,,,"
```

--------------------------------

### Smartsheet Integration Source Header Examples

Source: https://developers.smartsheet.com/api/smartsheet/openapi/alternateemailaddress/delete-alternate-email

Examples of the 'smartsheet-integration-source' header format for different integration types.

```text
AI,SampleOrg,My-AI-Connector-v2
SCRIPT,SampleOrg2,Accounting-updater-script
APPLICATION,SampleOrg3,SheetUpdater
```

```text
AI,SampleOrg,My-AI-Connector-v2
```

--------------------------------

### Get Row Response Schema

Source: https://developers.smartsheet.com/api/smartsheet/openapi/rows/copyormoverowdestination

Example JSON schema for a successful response when retrieving a row. It includes row details, cell information, and timestamps.

```JSON
{
  "id": 0,
  "sheetId": 0,
  "rowNumber": 1,
  "expanded": true,
  "cells": [
    { ... }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "modifiedAt": "2019-08-24T14:15:22Z"
}
```