List properties for an item

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

{
  "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": [
        {
          "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, 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 type parameter to filter by property type (numeric, formula, matrix, text, date, status)
Deleted Items: Use includeDeleted=true to include soft-deleted properties

GET

/

v1

/

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": "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": [
        {
          "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

Example:

"550e8400-e29b-41d4-a716-446655440000"

version

string | null

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

Example:

null

include_deleted

boolean

default:false

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

Example:

false

type

string | null

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

Example:

"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.

Response payload for listing properties.

items

PublicProperty · object[]

required

Show child attributes

count

integer

required

Update item Create property