Skip to main content
GET
/
api
/
v1
/
workspace
Get workspace details
curl --request GET \
  --url https://api.example.com/api/v1/workspace \
  --header 'x-calry-api-key: <api-key>'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "My Workspace",
  "slug": "my-workspace",
  "defaultCurrency": "USD",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-02T00:00:00.000Z",
  "defaultDiscountPercentage": 10
}

Authorizations

​
x-calry-api-key
string
header
required

Response

Workspace retrieved successfully

​
id
string
required

Unique identifier of the workspace

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
name
string
required

Name of the workspace

Example:

"My Workspace"

​
slug
string
required

Slug of the workspace

Example:

"my-workspace"

​
defaultCurrency
string
required

Default currency for the workspace

Example:

"USD"

​
createdAt
string<date-time>
required

When the workspace was created

Example:

"2025-01-01T00:00:00.000Z"

​
updatedAt
string<date-time>
required

When the workspace was last updated

Example:

"2025-01-02T00:00:00.000Z"

​
defaultDiscountPercentage
number

Default discount percentage to apply

Example:

10