GET
/
properties
/
v1
/
companies
/
properties
/
named
/
{property_name}
Get a Company Property
curl --request GET \
  --url https://api.hubapi.com/properties/v1/companies/properties/named/{property_name}
{
  "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>",
  "createdUserId": 123,
  "updatedUserId": 123
}

Path Parameters

​
property_name
string
required

The API name of the property that you wish to see metadata for.

Response

200 - application/json

Successful response with company property details

The response is of type object.