Skip to main content
GET
/
workspaces
/
{idOrSlug}
Retrieve a workspace
curl --request GET \
  --url https://api.retrac.co/workspaces/{idOrSlug} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "logo": null,
  "usage": 123,
  "usageLimit": 123,
  "itemsUsage": 123,
  "itemsLimit": 123,
  "storagesLimit": 123,
  "tagsLimit": 123,
  "usersLimit": 123,
  "plan": "free",
  "stripeId": "<string>",
  "billingCycleStart": 123,
  "createdAt": "<string>",
  "users": [
    {
      "role": "owner"
    }
  ],
  "inviteCode": "<string>"
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
idOrSlug
string
required

The ID or slug of the workspace.

Response

The retrieved workspace

​
id
string
required

The unique ID of the workspace.

​
name
string
required

The name of the workspace.

​
slug
string
required

The slug of the workspace.

​
logo
string | null
required

The logo of the workspace.

​
usage
number
required

The usage of the workspace.

​
usageLimit
number
required

The usage limit of the workspace.

​
itemsUsage
number
required

The items usage of the workspace.

​
itemsLimit
number
required

The items limit of the workspace.

​
storagesLimit
number
required

The storage units limit of the workspace.

​
tagsLimit
number
required

The tags limit of the workspace.

​
usersLimit
number
required

The users limit of the workspace.

​
plan
enum<string>
required

The plan of the workspace.

Available options:
free,
pro,
business,
business plus,
business extra,
business max,
enterprise
​
stripeId
string | null
required

The Stripe ID of the workspace.

​
billingCycleStart
number
required

The date and time when the billing cycle starts for the workspace.

​
createdAt
string
required

The date and time when the workspace was created.

​
users
object[]
required

The role of the authenticated user in the workspace.

​
inviteCode
string | null
required

The invite code of the workspace.