curl --request GET \
--url https://api.poelis.com/v1/public/products \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.poelis.com/v1/public/products"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.poelis.com/v1/public/products', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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"
},
"part_number": "JE-1000-A",
"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"
}
]
}{
"error": "unauthorized",
"message": "Invalid or missing API key"
}{
"error": "forbidden",
"message": "Access denied"
}{
"error": "not_found",
"message": "Not found"
}{
"error": "validation_error",
"message": "Invalid data format",
"details": {
"errors": [
{
"loc": [
"body",
"field_name"
],
"msg": "field required",
"type": "value_error.missing"
}
]
}
}{
"error": "rate_limit_exceeded",
"message": "Too many requests"
}List products in a workspace
Retrieve a paginated list of products within a specific workspace.
Overview
This endpoint returns products from a workspace, with support for pagination and optional search filtering. Products are the main organizational unit that contains items and properties.
Search Functionality
Use the q parameter to filter products by name:
- Case-insensitive partial match
- Searches within product names
- Example:
q=enginewill match “Engine Specifications”, “Engine Design”, etc.
curl --request GET \
--url https://api.poelis.com/v1/public/products \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.poelis.com/v1/public/products"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.poelis.com/v1/public/products', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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"
},
"part_number": "JE-1000-A",
"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"
}
]
}{
"error": "unauthorized",
"message": "Invalid or missing API key"
}{
"error": "forbidden",
"message": "Access denied"
}{
"error": "not_found",
"message": "Not found"
}{
"error": "validation_error",
"message": "Invalid data format",
"details": {
"errors": [
{
"loc": [
"body",
"field_name"
],
"msg": "field required",
"type": "value_error.missing"
}
]
}
}{
"error": "rate_limit_exceeded",
"message": "Too many requests"
}Authorizations
Enter your API key. Example: Bearer poelis_api_...
Query Parameters
The unique identifier (UUID) of the workspace to list products from
"550e8400-e29b-41d4-a716-446655440000"
Optional search query to filter results.
Maximum number of items to return per page. Must be between 1 and 200.
1 <= x <= 200Number of items to skip from the beginning of the result set. Used for pagination.
x >= 0Response
Paginated list of products in the workspace. Each product includes partNumber, owner, createdBy, updatedBy (id, userName, imageUrl), createdAt, and updatedAt (ISO 8601) when available.