The API key making this request

GET

/api/v1/api-key

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

Lets a program, such as the MCP server, find the workspace its key works in.

Responses

200

application/json

object

apiKeyId

required

string format: uuid

workspaceId

required

The one workspace the key works in

string format: uuid

role

required

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 the key may do

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

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