A workspace and your role in it

GET

/api/v1/workspaces/{workspaceId}

const url = 'https://api.crossmart.io/api/v1/workspaces/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.crossmart.io/api/v1/workspaces/example

Parameters

Path Parameters

workspaceId

required

string

Responses

200

application/json

object

required

string format: uuid

organizationId

required

string format: uuid

name

required

string

displayName

required

The name to show: the organization name while the workspace is named Default

string

slug

required

string

currency

required

ISO 4217 code of the catalog prices

string

timeZone

required

IANA time zone that reports follow; null until set

string

nullable

role

required

Your role here

string

Allowed values: OWNER ADMIN EDITOR APPROVER VIEWER CUSTOM

customRole

required

The workspace’s own role, when role is CUSTOM

object

required

string format: uuid

name

required

string

permissions

required

What your role lets you do here. Check these, not the role, to adapt a UI.

Array<string>

Allowed values: workspace:view workspace:manage workspace:delete members:view members:manage api-keys:manage products:view products:edit inventory:view inventory:edit orders:view reports:view channels:view channels:manage listings:edit activity:view suggestions:view suggestions:approve billing:view ai:generate

Example

{
  "currency": "USD",
  "timeZone": "Asia/Jerusalem",
  "role": "OWNER",
  "permissions": [
    "workspace:view"
  ]
}