Skip to main content
POST
/
properties
/
search
Search properties by name or value
curl --request POST \
  --url https://api.rallyuxr.com/api/public/v1/properties/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "searchQuery": "consent",
  "propertyType": "SINGLE_SELECT",
  "populationId": "<string>",
  "propertyGroupId": "<string>",
  "pageInfo": {
    "size": 10
  }
}
'
{
  "results": [
    {
      "propertyId": "<string>",
      "name": "<string>",
      "propertyType": "SINGLE_SELECT",
      "description": "<string>",
      "propertyGroupId": "<string>",
      "propertyOptions": [
        {
          "propertyOptionId": "<string>",
          "name": "<string>",
          "order": "1"
        }
      ]
    }
  ],
  "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.

Body

application/json

Search for properties in the workspace

​
searchQuery
string

Text to search for across property names and values

Minimum string length: 1
Example:

"consent"

​
propertyType
enum<string>

Filter results by property type

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

"SINGLE_SELECT"

​
populationId
string

Filter results by population id

Minimum string length: 1
​
propertyGroupId
string

Filter results by property group id

Minimum string length: 1
​
pageInfo
object

Pagination arguments. Use startCursor from the result of the endCursor of the response to get the next page. Pagination in reverse is not currently supported

Example:
{ "size": 10 }

Response

The matching properties

​
results
object[]
required
​
total
number
required

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

​
pageInfo
object
required

Information about the current page