Skip to main content
GET
/
workspaces
/
{id}
Get workspace
curl --request GET \
  --url https://productlane.com/api/v1/workspaces/{id}
{
  "workspace": {
    "id": "<string>",
    "name": "<string>",
    "domain": "<string>",
    "darkMode": true,
    "backgroundColor": "<string>",
    "darkModeBackgroundColor": "<string>",
    "textColor": "<string>",
    "darkModeTextColor": "<string>",
    "accentColor": "<string>",
    "darkModeAccentColor": "<string>",
    "accentTextColor": "<string>",
    "darkModeAccentTextColor": "<string>",
    "buttonTextColor": "<string>",
    "darkModeButtonTextColor": "<string>",
    "customDomain": "<string>",
    "logoLink": "<string>",
    "logoUrl": "<string>",
    "changelogPublic": true
  },
  "latestChangelog": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "isDeleted": true,
    "version": 123,
    "date": "2023-11-07T05:31:56Z",
    "published": true,
    "title": "<string>",
    "archived": true,
    "imageUrl": "<string>",
    "projectId": "<string>",
    "workspaceId": "<string>",
    "notes": "<unknown>"
  }
}

​
Get Workspace

Fetch any given workspace with an ID. No authentication is required.

​
Path Parameters

​
id
string
required
Unique identifier of the workspace

​
Response

​
workspace
object
Workspace information
​
workspace.id
string
Unique identifier for the workspace
​
workspace.name
string
Workspace name
​
workspace.slug
string
Workspace URL slug
​
workspace.domain
string
Custom domain for the workspace
Workspace logo URL
​
workspace.primaryColor
string
Primary brand color (hex code)
​
workspace.secondaryColor
string
Secondary brand color (hex code)
​
workspace.isPublished
boolean
Whether the workspace portal is published
​
workspace.createdAt
string
Timestamp when the workspace was created
​
workspace.updatedAt
string
Timestamp when the workspace was last updated
​
latestChangelog
object
Most recent changelog entry
​
latestChangelog.id
string
Changelog ID
​
latestChangelog.title
string
Changelog title
​
latestChangelog.date
string
Changelog date
​
latestChangelog.published
boolean
Whether the changelog is published

​
Example Request

GET /api/v1/workspaces/ws_123456789

​
Example Response

{
  "workspace": {
    "id": "ws_123456789",
    "name": "Acme Corp",
    "slug": "acme-corp",
    "domain": "feedback.acme.com",
    "logo": "https://cdn.productlane.com/logos/acme.png",
    "primaryColor": "#3B82F6",
    "secondaryColor": "#1E40AF",
    "isPublished": true,
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  },
  "latestChangelog": {
    "id": "changelog_123",
    "title": "Dashboard Redesign Released",
    "date": "2024-01-15T00:00:00Z",
    "published": true
  }
}

Path Parameters

​
id
string
required

Response

Successful response

​
workspace
object
required
​
latestChangelog
object
required