Quick Start

Get up and running with the Poelis Public API in just a few steps.

Prerequisites

A Poelis account and a REST API key — create one under Settings ↗︎ → Manage REST API Keys ↗︎ (see Authentication for details)
curl or any HTTP client

Step 1: Make Your First Request

List workspaces in your organization. Use your REST API key in the Authorization: Bearer <key> header — see Authentication for how to get and use keys.

curl -X GET "https://api.poelis.com/v1/public/workspaces" \
  -H "Authorization: Bearer poelis_api_YOUR_KEY_HERE"

import requests

headers = {
    "Authorization": "Bearer poelis_api_YOUR_KEY_HERE",
    "Content-Type": "application/json"
}

response = requests.get(
    "https://api.poelis.com/v1/public/workspaces",
    headers=headers
)

print(response.json())

const response = await fetch('https://api.poelis.com/v1/public/workspaces', {
  headers: {
    'Authorization': 'Bearer poelis_api_YOUR_KEY_HERE',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);

Step 2: Understand the Response

A successful response will look like this:

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "readable_id": "aerospace-engineering",
      "name": "Aerospace Engineering"
    }
  ],
  "count": 1
}

Step 3: Explore More Endpoints

Now that you’ve made your first request, try these:

List Products in a Workspace

curl -X GET "https://api.poelis.com/v1/public/products?workspace_id=YOUR_WORKSPACE_ID" \
  -H "Authorization: Bearer poelis_api_YOUR_KEY_HERE"

Get a Specific Item

curl -X GET "https://api.poelis.com/v1/public/items/YOUR_ITEM_ID" \
  -H "Authorization: Bearer poelis_api_YOUR_KEY_HERE"

List Properties for an Item

curl -X GET "https://api.poelis.com/v1/public/properties?item_id=YOUR_ITEM_ID" \
  -H "Authorization: Bearer poelis_api_YOUR_KEY_HERE"

Next Steps

Read the Authentication guide to learn more about REST API keys
Explore the API Reference for all available endpoints
Check out Rate Limiting to understand API limits
Review Error Handling for proper error management

Get Started

API Usage

Prerequisites

Step 1: Make Your First Request

Step 2: Understand the Response

Step 3: Explore More Endpoints

List Products in a Workspace

Get a Specific Item

List Properties for an Item

Next Steps

​Prerequisites

​Step 1: Make Your First Request

​Step 2: Understand the Response

​Step 3: Explore More Endpoints

​List Products in a Workspace

​Get a Specific Item

​List Properties for an Item

​Next Steps

Prerequisites

Step 1: Make Your First Request

Step 2: Understand the Response

Step 3: Explore More Endpoints

List Products in a Workspace

Get a Specific Item

List Properties for an Item

Next Steps