Skip to main content
Welcome to the Poelis Public API documentation. This API provides programmatic access to your Poelis workspace data, enabling you to integrate Poelis into your workflows and build custom applications.

What is Poelis?

Poelis is an AI-native PLM (Product Lifecycle Management) system that helps engineering teams manage product data, specifications, and documentation. The Public API allows you to:
  • Access Workspaces: List and retrieve workspace information
  • Manage Products: Access product data within your workspaces
  • Query Items: Retrieve items and their hierarchical structure
  • Read Properties: Access property values, metadata, and references

API Overview

The Poelis Public API is a RESTful API that follows standard HTTP conventions:
  • Base URL: https://api.poelis.com
  • Authentication: Bearer token (REST API Key) in the Authorization header
  • Content Type: JSON for requests and responses
  • Versioning: All endpoints are versioned under /v1/public/

Quick Start

Get up and running with your first API request in minutes

Authentication

Learn how to authenticate your API requests

API Reference

Complete reference for all available endpoints

Rate Limiting

Understand rate limits and how to handle them

Core Concepts

Workspaces

Workspaces are the top-level organizational unit in Poelis. Each workspace belongs to an organization and contains products, items, and properties.

Products

Products are collections of related items within a workspace. They represent a specific product line, project, or system.

Items

Items are the building blocks of products. They can be organized hierarchically (items can have parent items) and contain properties.

Properties

Properties are attributes attached to items. They can be of different types:
  • Numeric: Numbers with optional units and categories
  • Text: String values
  • Date: Date and timestamp values
  • Status: Enumeration/status values

API Status

The Poelis API is actively maintained and versioned. Breaking changes will be communicated in advance and new versions will be released with backward compatibility when possible.