Skip to main content
GET
/
properties
/
{propertyId}
Get a person property by ID
curl --request GET \
  --url https://api.rallyuxr.com/api/public/v1/properties/{propertyId} \
  --header 'Authorization: Bearer <token>'
{
  "propertyId": "<string>",
  "name": "<string>",
  "propertyType": "SINGLE_SELECT",
  "propertyOptions": [
    {
      "propertyOptionId": "<string>",
      "name": "<string>",
      "order": "1"
    }
  ],
  "isUnique": true,
  "isPHI": true,
  "isPII": true,
  "description": "<string>",
  "propertyGroupId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
propertyId
string
required

Response

The person property

An individual person property

​
propertyId
string
required

The unique identifier of the property

​
name
string
required

The name of the property

​
propertyType
enum<string>
required

The type of the property

Available options:
STRING,
NUMBER,
DATETIME,
BOOLEAN,
SINGLE_SELECT,
MULTI_SELECT,
LOCATION
Example:

"SINGLE_SELECT"

​
propertyOptions
object[]
required

Options for a SINGLE_SELECT or MULTI_SELECT property. Empty for other property types.

​
isUnique
boolean
required

Whether the property is unique across all people. Maximum of 10 across a workspace

​
isPHI
boolean
required

Whether the property is PHI (Protected health information)

​
isPII
boolean
required

Whether the property is PII (Personally Identifiable Information)

​
description
string | null
required

The description of the property

​
propertyGroupId
string | null
required

The identifier of the property group this property belongs to. A property group is a collection of properties that apply to either all people in the workspace or a specific set of populations.