> ## 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 Custom Attribute

> Retrieves a [custom attribute](entity:CustomAttribute) associated with a location.

`square.retrieveLocationCustomAttribute` retrieves a [custom attribute](entity:CustomAttribute) associated with a location.

## Example

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

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

  square.retrieveLocationCustomAttribute({
    locationId: "location_id",
    key: "key",
    withDefinition: true,
    version: 1,
  })
})
```

## Inputs

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

| Field            | Type              | Required | Default | Description                                                                                                                                                                                                                                                                                                                                               |
| ---------------- | ----------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `locationId`     | `string`          | Yes      | —       | The ID of the target location.                                                                                                                                                                                                                                                                                                                            |
| `key`            | `string`          | Yes      | —       | The key of the custom attribute to retrieve. This key must match the `key` of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.                                                                                                                      |
| `withDefinition` | `boolean \| null` | No       | `false` | Indicates whether to return the custom attribute definition in the `definition` field of the custom attribute. Set this parameter to `true` to get the name and description of the custom attribute, information about the data type, or other definition details. The default value is `false`.                                                          |
| `version`        | `number \| null`  | No       | —       | The current version of the custom attribute, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. When included in the request, Square returns the specified version or a higher version if one exists. If the specified version is higher than the current version, Square returns a `BAD_REQUEST` error. |

Use the official [RetrieveLocationCustomAttribute reference](https://developer.squareup.com/reference/square/location-custom-attributes-api/retrieve-location-custom-attribute) for provider field semantics and limits.

## Output

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