Every role: the built-in ones with their permissions, and custom ones

GET

/api/v1/workspaces/{workspaceId}/roles

const url = 'https://api.crossmart.io/api/v1/workspaces/example/roles';
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/roles

Parameters

Path Parameters

workspaceId

required

string

Responses

200

application/json

object

builtIn

required

Most access first

Array<object>

object

role

required

string

Allowed values: OWNER ADMIN EDITOR APPROVER VIEWER CUSTOM

permissions

required

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

custom

required

By name

Array<object>

object

required

string format: uuid

name

required

string

description

required

string

nullable

permissions

required

Array<string>

memberCount

required

Members holding the role now

number

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "builtIn": [
    {
      "role": "OWNER",
      "permissions": [
        "workspace:view"
      ]
    }
  ],
  "custom": [
    {
      "permissions": [
        "workspace:view"
      ]
    }
  ]
}