---
title: "Get sheet settings"
method: GET
path: "/sheets/{sheetId}/settings"
tags: ["sheets"]
---

# Get sheet settings

`GET /sheets/{sheetId}/settings`

## Request

- Base URL: `https://api.orcascan.com/v1`
- URL: `https://api.orcascan.com/v1/sheets/{sheetId}/settings`
- Auth: HTTP bearer

## Response `200`

Sheet settings wrapped in data envelope

- object
  - `data` SheetSettings: Read-only sheet settings returned when reading settings
    - `allowPublicExport` boolean: Allow the sheet data to be exported publicly
    - `allowPublicEntry` boolean: Allow public data entry via a form
    - `allowWebHookIn` boolean: Allow inbound webhooks to add rows
    - `lookupUrl` string: URL used to look up data
    - `validationUrl` string: URL used to validate rows
    - `webHookOutUrl` string: Outbound webhook URL called when rows change
    - `secret` string: Shared secret sent with webhook requests
    - `dataSourceName` string[]: Data source names this sheet provides
    - `itemLinkMode` 'Do nothing' | 'Show details' | 'Collect data' | 'Redirect to URL': What happens when the item link is scanned
    - `itemLinkFields` string[]: Fields shown via the item link
    - `itemLinkRedirectUrl` string: URL to redirect to when itemLinkMode is 'Redirect to URL'
    - `itemLinkPinProtected` boolean: Require a PIN to open the item link
    - `qrFormPinProtected` boolean: Require a PIN to open the QR form
    - `publicExportUrl` string: Public export URL (read-only)
    - `publicEntryUrl` string: Public entry form URL (read-only)
    - `webHookInUrl` string: Inbound webhook URL (read-only)
    - `dateTimeFormat` string: Sheet date/time format (read-only)
    - `itemLinkPin` string: Item link PIN (read-only)
    - `qrFormPin` string: QR form PIN (read-only)

## Other responses

- `401`: Missing or invalid API key
- `429`: Rate limit exceeded (15 requests/sec per IP). Retry after the specified delay.

---

[API](https://skmtc.dev/orcascan/apis/orca-scan-rest-api.md) · [All operations](https://skmtc.dev/orcascan/apis/orca-scan-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/orcascan/apis/orca-scan-rest-api/revisions/13236cc773c3?raw)