Skip to content

Get the workspace

GET
/api/v1/workspace
curl --request GET \
--url https://digize.com/api/v1/workspace \
--header 'x-api-key: <x-api-key>'

The workspace’s name, logo, time zone and currency. Money and dates are shown in these.

Needs the settings:read permission.

Done

Media typeapplication/json
object
id
required
string
name
required
string
timezone
required
string
currency
required
string
logoImageId
required
string | null
logoUrl
required
string | null
createdAt
required
string format: date-time

Example generated

{
"id": "example",
"name": "example",
"timezone": "example",
"currency": "example",
"logoImageId": "example",
"logoUrl": "example",
"createdAt": "2026-04-15T12:00:00Z"
}

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}