Person Properties

Search properties by name or value

post/properties/search

Request

  • Base URL: https://api.rallyuxr.com/api/public/v1
  • URL: https://api.rallyuxr.com/api/public/v1/properties/search
  • Auth: HTTP bearer

Request body

searchQuerystring

Text to search for across property names and values

propertyType'STRING' | 'NUMBER' | 'DATETIME' | 'BOOLEAN' | 'SINGLE_SELECT' | 'MULTI_SELECT' | 'LOCATION'

Filter results by property type

populationIdstring

Filter results by population id

propertyGroupIdstring

Filter results by property group id

Example request

{
  "searchQuery": "consent",
  "propertyType": "SINGLE_SELECT",
  "pageInfo": {
    "size": 10
  }
}

Response

The matching properties

totalnumber required

The total number of items in your workspaces based on your search parameters

Example response

{
  "results": [
    {
      "propertyType": "SINGLE_SELECT",
      "propertyOptions": [
        {
          "order": "1"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.