Skip to main content
GET
/
v1
/
public
/
products
List products in a workspace
curl --request GET \
  --url https://api.poelis.com/v1/public/products \
  --header 'Authorization: Bearer <token>'
{
  "count": 2,
  "items": [
    {
      "archived": false,
      "baseline_version_number": 5,
      "createdBy": {
        "id": "auth0|550e8400-e29b-41d4-a716-446655440000",
        "imageUrl": "https://example.com/avatar.png",
        "userName": "Jane Doe"
      },
      "excludedStatusIds": [],
      "id": "660e8400-e29b-41d4-a716-446655440000",
      "name": "Jet Engine Specifications",
      "owner": {
        "id": "auth0|550e8400-e29b-41d4-a716-446655440000",
        "imageUrl": "https://example.com/avatar.png",
        "userName": "Jane Doe"
      },
      "readable_id": "jet-engine-specs",
      "status": {
        "color": "#3b82f6",
        "groupKey": "started",
        "id": "770e8400-e29b-41d4-a716-446655440999",
        "name": "In Progress"
      },
      "workspace_id": "550e8400-e29b-41d4-a716-446655440000"
    },
    {
      "createdBy": {
        "id": "auth0|550e8400-e29b-41d4-a716-446655440000",
        "imageUrl": "https://example.com/avatar.png",
        "userName": "Jane Doe"
      },
      "id": "660e8400-e29b-41d4-a716-446655440001",
      "name": "Turbine Blade Design",
      "owner": {
        "id": "auth0|550e8400-e29b-41d4-a716-446655440000",
        "imageUrl": "https://example.com/avatar.png",
        "userName": "Jane Doe"
      },
      "readable_id": "turbine-blade-design",
      "workspace_id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.poelis.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
workspace_id
string
required

The unique identifier (UUID) of the workspace to list products from

Example:

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

​
q
string

Optional search query to filter results.

​
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 products in the workspace. Each product includes owner, createdBy, updatedBy (id, userName, imageUrl), createdAt, and updatedAt (ISO 8601) when available.

Response payload for listing products.

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