---
title: "Retrieve the object requirement status for a custom action definition."
method: GET
path: "/automation/actions/2026-09/{appId}/{definitionId}/requires-object"
tags: ["Definitions"]
---

# Retrieve the object requirement status for a custom action definition.

`GET /automation/actions/2026-09/{appId}/{definitionId}/requires-object`

## Request

- Base URL: `https://api.hubapi.com`
- URL: `https://api.hubapi.com/automation/actions/2026-09/{appId}/{definitionId}/requires-object`
- Auth: API key in query parameter `hapikey`

Retrieve whether a custom action definition requires an object.

## Path parameters

- `appId` integer, required
- `definitionId` string, required

## Response `200`

successful operation

- PublicActionDefinitionRequiresObjectResponse
  - `requiresObject` boolean, required: Indicates whether a custom action definition requires an object.

## Other responses

- `default`: An error occurred.

## Changes

- **2026-09-11** (2026-09) `a516396e0463`: 2 info
  - the endpoint scheme security `developer_hapikey` was added to the API
  - the endpoint scheme security `oauth2` was removed from the API
- **2026-09-03** (2026-09) `c6eb28324e2a`: 4 info
  - the endpoint scheme security `oauth2` was added to the API
  - the endpoint scheme security `developer_hapikey` was removed from the API
  - api tag `Definitions` added
  - api tag `Basic` removed

[Operation history](https://skmtc.dev/hubspot/apis/automation-actions-v4/changes/automation/actions/2026-09/:appId/:definitionId/requires-object/get.md)

---

[API](https://skmtc.dev/hubspot/apis/automation-actions-v4.md) - [All operations](https://skmtc.dev/hubspot/apis/automation-actions-v4/llms.txt) - [OpenAPI document](https://skmtc.dev/hubspot/apis/automation-actions-v4/revisions/bfab10ea153c?raw)