Skip to main content
GET
/
properties
/
v1
/
deals
/
properties
/
Get all deal properties
curl --request GET \
  --url https://api.hubapi.com/properties/v1/deals/properties/
[
  {
    "name": "<string>",
    "label": "<string>",
    "description": "<string>",
    "groupName": "<string>",
    "type": "string",
    "fieldType": "textarea",
    "options": [
      {
        "description": "<string>",
        "label": "<string>",
        "value": "<string>",
        "displayOrder": 123,
        "hidden": true,
        "readOnly": true,
        "doubleData": 123
      }
    ],
    "displayOrder": 123,
    "formField": true,
    "readOnlyValue": true,
    "readOnlyDefinition": true,
    "hidden": true,
    "mutableDefinitionNotDeletable": true,
    "favorited": true,
    "favoritedOrder": 123,
    "calculated": true,
    "externalOptions": true,
    "displayMode": "<string>",
    "hubspotDefined": true,
    "createdAt": 123,
    "updatedAt": 123,
    "createdUserId": 123,
    "updatedUserId": 123
  }
]

Response

200 - application/json

Successful response with all deal properties

​
name
string

The internal name of the property

​
label
string

A human readable label for the property

​
description
string

A description of the property

​
groupName
string

The property group that the property belongs to

​
type
enum<string>

The data type that the property stores

Available options:
string,
number,
bool,
datetime,
enumeration
​
fieldType
enum<string>

Controls how the property appears when used in forms

Available options:
textarea,
select,
text,
date,
file,
number,
radio,
checkbox
​
options
object[]

Options for enumeration properties

​
displayOrder
integer

Used to control the default order of the property within the property group

​
formField
boolean

Whether the property can be used in forms

​
readOnlyValue
boolean

Whether the property value is read-only

​
readOnlyDefinition
boolean

Whether the property definition is read-only

​
hidden
boolean

Whether the property is hidden

​
mutableDefinitionNotDeletable
boolean

Whether the property definition can be deleted

​
favorited
boolean

Whether the property is favorited

​
favoritedOrder
integer

The order of the property in the favorites list

​
calculated
boolean

Whether the property is calculated

​
externalOptions
boolean

Whether the property uses external options

​
displayMode
string

The display mode of the property

​
hubspotDefined
boolean

Whether the property is defined by HubSpot

​
createdAt
integer

Timestamp when the property was created

​
updatedAt
integer

Timestamp when the property was last updated

​
createdUserId
integer

The ID of the user who created the property

​
updatedUserId
integer

The ID of the user who last updated the property