HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Get One Property

Return a Property with the corresponding {keyName}.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Retrieve one property key by keyName.

Use this endpoint when you already know the property key and need its metadata, such as data type, display name, formula details, entity ownership, or possible choices. To find property keys by data type, family, keyspace, or entity, use Get Properties.

Resource URI

GET /rest/public/properties/{keyName}

Path parameters

ParameterTypeDescription
keyNameStringUnique name for the property key. Required.

For the full PropertyKey data model and examples, see Properties.

Example

GET /rest/public/properties/billingPeriodYearFactor

A successful response returns a standard response payload with type set to PropertyKey and one property key in the results array.

Path Params
string
required

The unique name for this property.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json