> ## 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 Catalog Object

> Returns a single [CatalogItem](entity:CatalogItem) as a [CatalogObject](entity:CatalogObject) based on the provided ID.

`square.retrieveCatalogObject` returns a single [CatalogItem](entity:CatalogItem) as a [CatalogObject](entity:CatalogObject) based on the provided ID.

## Example

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

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

  square.retrieveCatalogObject({
    objectId: "object_id",
    includeRelatedObjects: true,
    catalogVersion: BigInt("1000000"),
    includeCategoryPathToRoot: true,
  })
})
```

## Inputs

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

| Field                       | Type              | Required | Default | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| --------------------------- | ----------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `objectId`                  | `string`          | Yes      | —       | The object ID of any type of catalog objects to be retrieved.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `includeRelatedObjects`     | `boolean \| null` | No       | —       | If `true`, the response will include additional objects that are related to the requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field of the response. These objects are put in the `related_objects` field. Setting this to `true` is helpful when the objects are needed for immediate display to a user. This process only goes one level deep. Objects referenced by the related objects will not be included. For example, if the `objects` field of the response contains a CatalogItem, its associated CatalogCategory objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false` |
| `catalogVersion`            | `bigint \| null`  | No       | —       | Requests objects as of a specific version of the catalog. This allows you to retrieve historical versions of objects. The value to retrieve a specific version of an object can be found in the version field of CatalogObjects. If not included, results will be from the current version of the catalog.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `includeCategoryPathToRoot` | `boolean \| null` | No       | —       | Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned in the response payload.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |

Use the official [RetrieveCatalogObject reference](https://developer.squareup.com/reference/square/catalog-api/retrieve-catalog-object) for provider field semantics and limits.

## Output

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