Organizations

Count owner records holding a value for one configured property

GET
/api/organizations/sections/{id}/property-usage

Returns how many owner records currently hold a non-empty value for a single configured property, so the settings editor can warn before a data type change leaves stored values inconsistent with their new type. Built-in types are counted on their own collection; a custom type has no collection of its own, so the linkId graph is walked and every branch that attaches it is probed. Legacy display-name and oldName aliases are probed too, since a value written under one still resolves on read. Read-only. Org members may read their own org; SuperAdmin can read any org.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Query Parameters

type?string
Default"Contact"
key*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/organizations/sections/string/property-usage?key=string"
{  "count": 2,  "paths": [    "vehicleFinancing.loanAmount",    "vehicleFinancing.Loan Amount"  ]}