List properties for an item

curl --request GET \
  --url https://api.poelis.com/v1/public/properties \
  --header 'Authorization: Bearer <token>'

{
  "count": 1,
  "items": [
    {
      "category": "Performance",
      "deleted": false,
      "display_unit": "kW",
      "has_changes": false,
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "item_id": "660e8400-e29b-41d4-a716-446655440001",
      "name": "Maximum Power",
      "owner": "Engineering Team",
      "position": 1,
      "readable_id": "max-power",
      "references": [
        {
          "item_document_id": "770e8400-e29b-41d4-a716-446655440002",
          "page": 42
        }
      ],
      "type": "numeric",
      "value": 150.5
    }
  ]
}

Properties

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: Numeric values with optional category and display unit. Can include formula expressions that calculate values from other properties.
text: Text-based properties
date: Date and timestamp properties
status: Status/enumeration properties

Versioning

Use the version parameter to retrieve properties from a specific product version:

Provide an integer version number (e.g., version=5)
Use version=baseline to get properties from the baseline version
Omit the parameter to get draft properties

Filtering

Type Filter: Use type parameter to filter by property type (numeric, text, date, status)
Deleted Items: Use includeDeleted=true to include soft-deleted properties

GET

public

properties

List properties for an item

curl --request GET \
  --url https://api.poelis.com/v1/public/properties \
  --header 'Authorization: Bearer <token>'

{
  "count": 1,
  "items": [
    {
      "category": "Performance",
      "deleted": false,
      "display_unit": "kW",
      "has_changes": false,
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "item_id": "660e8400-e29b-41d4-a716-446655440001",
      "name": "Maximum Power",
      "owner": "Engineering Team",
      "position": 1,
      "readable_id": "max-power",
      "references": [
        {
          "item_document_id": "770e8400-e29b-41d4-a716-446655440002",
          "page": 42
        }
      ],
      "type": "numeric",
      "value": 150.5
    }
  ]
}

Authorizations

Authorization

string

header

required

Enter your API key. Example: Bearer poelis_api_...

Query Parameters

item_id

string

required

The unique identifier (UUID) of the item to retrieve properties for

version

string | null

Product version number (integer) or "baseline" to get properties from the baseline version. Omit to get draft properties.

include_deleted

boolean

default:false

If true, includes soft-deleted properties in the response. Defaults to false.

type

string | null

Filter properties by type. Allowed values: numeric, text, date, status. Case-insensitive.

Response

Unified list of all property types for the specified item with metadata and references

Response payload for listing properties.

items

PublicProperty · object[]

required

Show child attributes

count

integer

required

Get item by ID Get property by ID

⌘I

Overview

Workspaces

Products

Items

Properties

List properties for an item

Overview

Property Types

Versioning

Filtering

Authorizations

Query Parameters

Response