Skip to main content
GET
/
v1
/
public
/
properties
/
{property_id}
Get property by ID
curl --request GET \
  --url https://api.poelis.com/v1/public/properties/{property_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "readable_id": "<string>",
  "item_id": "<string>",
  "name": "<string>",
  "position": 123,
  "type": "numeric",
  "value": "<unknown>",
  "deleted": true,
  "has_changes": true,
  "category": "<string>",
  "display_unit": "<string>",
  "owner": "<string>",
  "draft_property_id": "<string>",
  "references": [
    {
      "item_document_id": "770e8400-e29b-41d4-a716-446655440002",
      "page": 42
    }
  ],
  "formula_expression": "<string>",
  "has_formula_dependency_changes": true
}

Authorizations

Authorization
string
header
required

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

Path Parameters

property_id
string
required

Query Parameters

type
string | null

Optional property type: numeric, text, date, or status. If not provided, will search all types. Case-insensitive.

Response

Complete property details including value, metadata, references, and versioning information

Unified public property representation.

id
string
required
readable_id
string
required

Human-readable property ID

item_id
string
required
name
string
required
position
number
required
type
enum<string>
required
Available options:
numeric,
text,
date,
status,
matrix
value
any
required
deleted
boolean
required
has_changes
boolean
required

Whether the property has draft changes

category
string | null
display_unit
string | null
owner
string | null
draft_property_id
string | null
references
PublicPropertyReference · object[]

References to source documents for this property

formula_expression
string | null

Formula expression for numeric properties that calculate their value from other properties. Uses @{property_id} syntax to reference dependencies.

has_formula_dependency_changes
boolean | null

Whether any of the formula's dependency properties have changed (only for numeric properties with formulas).