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

# HubSpot: Fetch Properties

> List the properties (fields) defined on a HubSpot object type, such as contact or company properties, before reading or writing records.

List the properties (fields) defined on a HubSpot object type, such as contact or company properties, before reading or writing records.

> [!NOTE]
>
> Tool ID: `hubspot_fetch_properties`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'hubspot_fetch_properties',
  {
    "name": "Example"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute hubspot_fetch_properties --input '{
  "name": "Example"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "results": [
      {
        "name": "Example",
        "label": "example",
        "type": "example",
        "fieldType": "example",
        "description": "Example description",
        "groupName": "Example",
        "options": [
          {}
        ],
        "displayOrder": 123,
        "calculated": true,
        "externalOptions": true,
        "hasUniqueValue": true,
        "hidden": true,
        "formField": true,
        "dataSensitivity": "example"
      }
    ]
  }
}
```

Use `deepline describe hubspot_fetch_properties --json` for the latest machine-readable contract.

## Input reference

Fetch HubSpot properties for a specific object type.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.name` | `string` | Yes | — | — |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Fetch HubSpot properties for a specific object type.",
    "properties": {
      "name": {
        "type": "string",
        "aliases": [
          "object_type",
          "objectType"
        ]
      }
    },
    "required": [
      "name"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.results` | `array` | Yes | — | — |
| `result.data.results[].createdAt` | `string` | No | — | — |
| `result.data.results[].updatedAt` | `string` | No | — | — |
| `result.data.results[].name` | `string` | Yes | — | — |
| `result.data.results[].label` | `string` | Yes | — | — |
| `result.data.results[].type` | `string` | Yes | — | — |
| `result.data.results[].fieldType` | `string` | Yes | — | — |
| `result.data.results[].description` | `string` | Yes | — | — |
| `result.data.results[].groupName` | `string` | Yes | — | — |
| `result.data.results[].options` | `array` | Yes | — | — |
| `result.data.results[].displayOrder` | `number` | Yes | — | — |
| `result.data.results[].calculated` | `boolean` | Yes | — | — |
| `result.data.results[].externalOptions` | `boolean` | Yes | — | — |
| `result.data.results[].hasUniqueValue` | `boolean` | Yes | — | — |
| `result.data.results[].hidden` | `boolean` | Yes | — | — |
| `result.data.results[].hubspotDefined` | `boolean` | No | — | — |
| `result.data.results[].showCurrencySymbol` | `boolean` | No | — | — |
| `result.data.results[].modificationMetadata` | `object` | No | — | — |
| `result.data.results[].modificationMetadata.archivable` | `boolean` | No | — | — |
| `result.data.results[].modificationMetadata.readOnlyDefinition` | `boolean` | No | — | — |
| `result.data.results[].modificationMetadata.readOnlyValue` | `boolean` | No | — | — |
| `result.data.results[].modificationMetadata.readOnlyOptions` | `boolean` | No | — | — |
| `result.data.results[].formField` | `boolean` | Yes | — | — |
| `result.data.results[].dataSensitivity` | `string` | Yes | — | — |
| `result.meta` | `record` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "createdAt": {
                  "type": "string"
                },
                "updatedAt": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                },
                "fieldType": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "groupName": {
                  "type": "string"
                },
                "options": {
                  "type": "array",
                  "items": {}
                },
                "displayOrder": {
                  "type": "number"
                },
                "calculated": {
                  "type": "boolean"
                },
                "externalOptions": {
                  "type": "boolean"
                },
                "hasUniqueValue": {
                  "type": "boolean"
                },
                "hidden": {
                  "type": "boolean"
                },
                "hubspotDefined": {
                  "type": "boolean"
                },
                "showCurrencySymbol": {
                  "type": "boolean"
                },
                "modificationMetadata": {
                  "type": "object",
                  "properties": {
                    "archivable": {
                      "type": "boolean"
                    },
                    "readOnlyDefinition": {
                      "type": "boolean"
                    },
                    "readOnlyValue": {
                      "type": "boolean"
                    },
                    "readOnlyOptions": {
                      "type": "boolean"
                    }
                  },
                  "additionalProperties": false
                },
                "formField": {
                  "type": "boolean"
                },
                "dataSensitivity": {
                  "type": "string"
                }
              },
              "required": [
                "name",
                "label",
                "type",
                "fieldType",
                "description",
                "groupName",
                "options",
                "displayOrder",
                "calculated",
                "externalOptions",
                "hasUniqueValue",
                "hidden",
                "formField",
                "dataSensitivity"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "results"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": {}
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [HubSpot provider guide](https://deepline.com/docs/providers/hubspot/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.