Lists all properties
Permission level: read
GET /property
Operation id: PropertyService_ListProperties
Tags: PropertyService
Parameters
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
includeDisabled | boolean | No | Include disabled properties. Default: false |
pageSize | integer (int32) | No | Requested size of the next page of data. If not set, the default page size is 1000 for now to not break existing UI integrations, Required: false. |
pageToken | string | No | MongoDB Field, describes the encoded page token for page traversal, Required: false |
propertyCharacteristics.domain | string | No | The property is specific for this domain. Required = false |
propertyCharacteristics.parentDomain | string | No | The parent domain. Required = false |
propertyCharacteristics.parentPropertyKey | string | No | The parent property key. Required = false |
propertyCharacteristics.parentPropertyValue | string | No | The parent property value. Required = false |
propertyCharacteristics.parentScope | string | No | The parent scope. Required = false |
propertyCharacteristics.parentTenantId | string | No | The parent tenant id. Required = false |
propertyCharacteristics.scope | string | No | The property is specific for this scope. Required = false |
propertyCharacteristics.tenantId | string | No | The property is specific for this tenant. Required = false |
propertyFriendlyName | string | No | The property's friendly name to filter by, Required: false |
propertyKey | string | No | The propertyKey of the property to filter by, Required: false |
propertyValueName | string | No | The Value name of the property. this will always be converted to lowercase. Required = false |
sortField | string | No | Sort field, valid values: propertyKey, propertyValue. Default: propertyKey, Required: false |
sortType | string | No | Sort Type for the results, Default: ASC, Required: false |
startsWithSingleCharacter | boolean | No | Ability to search for a single starts with character, only applicable to property_value_name and property_friendly_name. Required: false, Default: false |
Security
- Authorization (apiKey)
- Bearer token
Responses
200 — A successful response.
Content type: application/json
default — An unexpected error response.
Content type: application/json
Response models
200 — A successful response.
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
propertyMaps | array | No | |
nextPageToken | string | No |
{
"type": "object",
"properties": {
"propertyMaps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"properties": {
"type": "object"
}
}
}
},
"nextPageToken": {
"type": "string"
}
}
}
default — An unexpected error response.
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
code | integer (int32) | No | |
message | string | No | |
details | array | No |
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
}
}
}
}
}
}