/v1/workspaces
GET
/v1/workspaces
const url = 'https://example.com/v1/workspaces?limit=50&offset=0';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://example.com/v1/workspaces?limit=50&offset=0' \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters”limit
Maximum number of items to return (max 100)
integer
Maximum number of items to return (max 100)
offset
integer | null
Responses
Section titled “ Responses ”Workspaces the caller is a member of
Media typeapplication/json
object
items
required
Array<object>
object
id
required
string format: uuid
ref
required
string | null
name
required
string
owned_by
required
string | null format: uuid
billing_type
required
string | null
is_standard
required
boolean
is_pro
required
boolean
is_premium
required
boolean
can_publish
required
boolean
feature_labels
required
boolean
feature_events
required
boolean
feature_marketing
required
boolean
feature_analytics
required
boolean
feature_media_kit
required
boolean
feature_packaging_units
required
boolean
included_marketing_qr_codes
required
integer | null
available_marketing_qr_codes
required
integer | null
atlas_listing_enabled
required
boolean | null
enable_allergen_text
required
boolean | null
enable_ppwr_operator_info
required
boolean | null
report_email_opt_in
required
boolean | null
premium_started_at
required
string | null
pro_started_at
required
string | null
default_label_design
required
string | null
onboarding_completed
required
boolean | null
limit
required
integer
offset
required
integer
has_more
required
boolean
Examplegenerated
{ "items": [ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "ref": "example", "name": "example", "owned_by": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "billing_type": "example", "is_standard": true, "is_pro": true, "is_premium": true, "can_publish": true, "feature_labels": true, "feature_events": true, "feature_marketing": true, "feature_analytics": true, "feature_media_kit": true, "feature_packaging_units": true, "included_marketing_qr_codes": 1, "available_marketing_qr_codes": 1, "atlas_listing_enabled": true, "enable_allergen_text": true, "enable_ppwr_operator_info": true, "report_email_opt_in": true, "premium_started_at": "example", "pro_started_at": "example", "default_label_design": "example", "onboarding_completed": true } ], "limit": 1, "offset": 1, "has_more": true}Invalid query parameters
Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
number
detail
string
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example"}Missing or invalid bearer token
Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
number
detail
string
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example"}Upstream error
Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
number
detail
string
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example"}