Skip to main content
GET
/
v1
/
public
/
items
List items in a product
curl --request GET \
  --url https://api.poelis.com/v1/public/items \
  --header 'Authorization: Bearer <token>'
{
  "count": 1,
  "items": [
    {
      "createdBy": {
        "id": "auth0|550e8400-e29b-41d4-a716-446655440000",
        "imageUrl": "https://example.com/avatar.png",
        "userName": "Jane Doe"
      },
      "deleted": false,
      "id": "770e8400-e29b-41d4-a716-446655440000",
      "name": "Compressor Stage 1",
      "product_id": "660e8400-e29b-41d4-a716-446655440000",
      "readable_id": "compressor-stage-1"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
product_id
string
required

The unique identifier (UUID) of the product to list items from

Example:

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

​
version
string | null

Product version number (integer) or 'baseline'. Omit or null for draft items.

Example:

null

​
include_deleted
boolean
default:false

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

Example:

false

​
limit
integer
default:50

Maximum number of items to return per page. Must be between 1 and 200.

Required range: 1 <= x <= 200
​
offset
integer
default:0

Number of items to skip from the beginning of the result set. Used for pagination.

Required range: x >= 0

Response

Paginated list of items in the product. Each item includes createdBy, updatedBy (id, userName, imageUrl), createdAt, and updatedAt (ISO 8601) when available.

Response payload for listing items.

​
items
PublicItem · object[]
required
​
count
integer
required