> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Retrieve Location Settings

> Retrieves the location-level settings for a Square-hosted checkout page.

`square.retrieveLocationSettings` retrieves the location-level settings for a Square-hosted checkout page.

## Example

```ts automations/square-retrieve-location-settings.automation.ts theme={null}
import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Retrieve Square Location Settings", () => {
  onDashboardRun({ title: "Retrieve Square Location Settings" })

  square.retrieveLocationSettings({
    locationId: "location_id",
  })
})
```

## Inputs

Every input accepts a compatible signal. It requires `MERCHANT_PROFILE_READ`.

| Field        | Type     | Required | Default | Description                                            |
| ------------ | -------- | -------- | ------- | ------------------------------------------------------ |
| `locationId` | `string` | Yes      | —       | The ID of the location for which to retrieve settings. |

Use the official [RetrieveLocationSettings reference](https://developer.squareup.com/reference/square/checkout-api/retrieve-location-settings) for provider field semantics and limits.

## Output

Returns the official `Square.RetrieveLocationSettingsResponse` response as a codec-safe object. Square integer money amounts remain `bigint` values.
