GET
/
properties
Get all person properties in your workspace
curl --request GET \
  --url https://api.rallyuxr.com/api/public/v1/properties \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "propertyId": "<string>",
      "name": "<string>",
      "propertyType": "SINGLE_SELECT",
      "propertyOptions": [
        {
          "propertyOptionId": "<string>",
          "name": "<string>",
          "color": "GREY",
          "order": "1"
        }
      ],
      "isUnique": true,
      "isPHI": true,
      "isPII": true
    }
  ],
  "total": 123,
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "<string>",
    "endCursor": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
startCursor
string

The cursor to start fetching from

​
size
number
default:10

The number of items to fetch

Required range: 0 < x <= 100
Example:

10

Response

200
application/json

The person properties

The response is of type object.