Skip to main content
GET
/
api
/
v1
/
workspaces
List workspaces
curl --request GET \
  --url https://api.getarca.app/api/v1/workspaces \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 3,
    "name": "Acme Corp",
    "slug": "acme-corp",
    "description": "Main product workspace",
    "icon": "briefcase",
    "color": "blue",
    "image_url": null,
    "owner_id": 1,
    "role": "owner",
    "created_at": "2026-01-05T10:00:00.000Z"
  }
]
Requires the workspaces:read scope.

​
Response

Returns an array of workspace objects.
​
id
number
required
Workspace identifier.
​
name
string
required
Workspace name.
​
slug
string
required
URL-safe identifier for the workspace.
​
description
string | null
Optional workspace description.
​
icon
string | null
Icon identifier slug (e.g., "folder-1", "chart", "briefcase"). null if not set.
​
color
string | null
Brand color.
​
image_url
string | null
Workspace cover image URL.
​
owner_id
number
required
User ID of the workspace owner.
​
role
string
required
Your role in this workspace. One of owner, admin, member, or viewer.
​
created_at
string
required
UTC ISO-8601 creation timestamp.
[
  {
    "id": 3,
    "name": "Acme Corp",
    "slug": "acme-corp",
    "description": "Main product workspace",
    "icon": "briefcase",
    "color": "blue",
    "image_url": null,
    "owner_id": 1,
    "role": "owner",
    "created_at": "2026-01-05T10:00:00.000Z"
  }
]