---
title: "List Properties"
method: GET
path: "/admin/hubspot-schema/properties"
tags: ["admin", "hubspot-schema"]
---

# List Properties

`GET /admin/hubspot-schema/properties`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/admin/hubspot-schema/properties`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Properties on one CRM object, optionally filtered by substring of name or label.

Filter on the label when you know what someone called it in the UI, and read back the
``name`` — that is the value a properties request has to use. ``type`` and
``field_type`` say whether a value is an owner id, an enum or free text, which decides
whether it can be mapped exactly or only guessed at.

``include_options`` adds an enumeration's allowed values. Off by default because a full
listing drowns in them, but for an enum they are the whole question: whether the stored
value is something joinable like an email, or a display name that can only be matched
by guessing.

## Query parameters

- `object_type` string
- `contains` string, nullable
- `include_options` boolean

## Headers

- `organization-id` string, nullable
- `timezone` string
- `x-user-id` string, nullable
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Response `200`

Successful Response

- object

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/upsmith/apis/upsmith-api.md) - [All operations](https://skmtc.dev/upsmith/apis/upsmith-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upsmith/apis/upsmith-api/revisions/86e2c2bd93af?raw)