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. For Python, go to the Python SDK. New to Poelis? See the user manual Overview and basic concepts before working with the API.

​
API capabilities

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
  • Work with Files: List, upload, update, and download files attached to items and properties
  • Read Organization Members: List users in your organization together with their organization, workspace, and product access

​
The API

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

Public REST API

Complete reference for all available endpoints

Rate Limiting

Understand rate limits and how to handle them

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