curl --request GET \
--url https://api.poelis.com/v1/public/properties \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.poelis.com/v1/public/properties"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.poelis.com/v1/public/properties', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"count": 1,
"items": [
{
"category": "POWER",
"createdBy": {
"id": "auth0|550e8400-e29b-41d4-a716-446655440000",
"imageUrl": "https://example.com/avatar.png",
"userName": "Jane Doe"
},
"deleted": false,
"display_unit": "kW",
"id": "550e8400-e29b-41d4-a716-446655440000",
"item_id": "660e8400-e29b-41d4-a716-446655440001",
"name": "Maximum Power",
"readable_id": "max-power",
"references": [
{
"file_link_id": "890e8400-e29b-41d4-a716-446655440000",
"page": 42
}
],
"type": "numeric",
"value": 150.5
}
]
}{
"error": "unauthorized",
"message": "Invalid or missing API key"
}{
"error": "forbidden",
"message": "Access denied"
}{
"error": "not_found",
"message": "Not found"
}{
"error": "validation_error",
"message": "Invalid data format",
"details": {
"errors": [
{
"loc": [
"body",
"field_name"
],
"msg": "field required",
"type": "value_error.missing"
}
]
}
}{
"error": "rate_limit_exceeded",
"message": "Too many requests"
}List properties for an item
Retrieve all properties for a specific item with optional filtering and versioning support.
Overview
This endpoint returns a unified response that includes all property types (numeric, text, date, status) in a single response format. Each property includes its value, metadata, references, and versioning information.
Property Types
The endpoint supports the following property types: numeric, formula, matrix, text, date, status. See the response model’s value, category, and display_unit field descriptions for numeric (plain number), formula (computed), and matrix semantics.
Versioning
- Omit or null
version: returns draft properties only. - Integer (e.g.
version=5): returns properties as of that product version. baseline: returns properties as of the product’s baseline version.
Filtering
- Type Filter: Use
typeparameter to filter by property type (numeric, formula, matrix, text, date, status) - Deleted Items: Use
includeDeleted=trueto include soft-deleted properties
curl --request GET \
--url https://api.poelis.com/v1/public/properties \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.poelis.com/v1/public/properties"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.poelis.com/v1/public/properties', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"count": 1,
"items": [
{
"category": "POWER",
"createdBy": {
"id": "auth0|550e8400-e29b-41d4-a716-446655440000",
"imageUrl": "https://example.com/avatar.png",
"userName": "Jane Doe"
},
"deleted": false,
"display_unit": "kW",
"id": "550e8400-e29b-41d4-a716-446655440000",
"item_id": "660e8400-e29b-41d4-a716-446655440001",
"name": "Maximum Power",
"readable_id": "max-power",
"references": [
{
"file_link_id": "890e8400-e29b-41d4-a716-446655440000",
"page": 42
}
],
"type": "numeric",
"value": 150.5
}
]
}{
"error": "unauthorized",
"message": "Invalid or missing API key"
}{
"error": "forbidden",
"message": "Access denied"
}{
"error": "not_found",
"message": "Not found"
}{
"error": "validation_error",
"message": "Invalid data format",
"details": {
"errors": [
{
"loc": [
"body",
"field_name"
],
"msg": "field required",
"type": "value_error.missing"
}
]
}
}{
"error": "rate_limit_exceeded",
"message": "Too many requests"
}Authorizations
Enter your API key. Example: Bearer poelis_api_...
Query Parameters
The unique identifier (UUID) of the item to retrieve properties for
"550e8400-e29b-41d4-a716-446655440000"
Product version number (integer) or "baseline" to get properties from the baseline version. Omit to get draft properties.
null
If true, includes soft-deleted properties in the response. Defaults to false.
false
Filter properties by type. Allowed values: numeric, formula, matrix, text, date, status. Case-insensitive.
"numeric"
Response
Unified list of all property types for the specified item with metadata, references, createdBy, updatedBy (id, userName, imageUrl), createdAt, and updatedAt (ISO 8601) when available.