Get Organization Property Definition

Returns a single organization property definition by slug.

Request

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

Path Parameters

/v2/organizations/properties/{slug}

Response

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

{
  "type" : "dropdown",
  "slug" : "industry",
  "name" : "Industry",
  "options" : [ {
    "label" : "Technology"
  }, {
    "label" : "Healthcare"
  }, {
    "label" : "Finance"
  }, {
    "label" : "Retail"
  } ],
  "_links" : {
    "self" : {
      "href" : "..."
    }
  }
}

Response fields

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