List Organization Property Definitions

Returns all organization property definitions for the account. Each account can have up to 50 property definitions.

Request

GET /v2/organizations/properties HTTP/1.1
Authorization: Bearer oauth_token

Response

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
  "_embedded" : {
    "organization-properties" : [ {
      "type" : "text",
      "slug" : "customer-tier",
      "name" : "Customer Tier"
    }, {
      "type" : "number",
      "slug" : "annual-revenue",
      "name" : "Annual Revenue"
    }, {
      "type" : "dropdown",
      "slug" : "industry",
      "name" : "Industry",
      "options" : [ {
        "label" : "Technology"
      }, {
        "label" : "Healthcare"
      }, {
        "label" : "Finance"
      }, {
        "label" : "Retail"
      } ]
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "..."
    }
  }
}

Response fields

Path Type Description
_embedded.organization-properties[].slug String Property definition’s unique slug identifier
_embedded.organization-properties[].name String Property definition’s display name
_embedded.organization-properties[].type String Property type. Possible values: text, number, url, date, dropdown
_embedded.organization-properties[].options Array Available options for dropdown type properties. Not present for other types.
_embedded.organization-properties[].options[].label String The display label for a dropdown option
↑Back to top