Skip to main content
POST
Search properties by name or value

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:

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