Workspace

Your workspace and who is calling.

Who is calling

GET/v1/me

Response 200

data

workspaceIdstringrequired
userobject | nullrequired
Null when called with an API key.
user
- userIdstringrequired
- emailstring
rolestring | nullrequired
The dashboard user’s role; null with an API key.
Values: owner · admin · member

curl "https://api.usecrier.com/v1/me" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/me', {
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.get(
    "https://api.usecrier.com/v1/me",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Get the workspace

GET/v1/workspace

Response 200

data

idstringrequired
namestringrequired
usagestring | nullrequired
Values: api · self
requireApprovalbooleanrequired
Posts by members wait for an owner or admin to approve them.
createdAtstring (date-time)required

curl "https://api.usecrier.com/v1/workspace" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/workspace', {
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.get(
    "https://api.usecrier.com/v1/workspace",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Update the workspace

PATCH/v1/workspaceDashboard only

Body

namestring
max 100
usagestring
Values: api · self
requireApprovalboolean
Posts by members wait for an owner or admin to approve them.

Response 200

data

idstringrequired
namestringrequired
usagestring | nullrequired
Values: api · self
requireApprovalbooleanrequired
Posts by members wait for an owner or admin to approve them.
createdAtstring (date-time)required

curl -X PATCH "https://api.usecrier.com/v1/workspace" \
  -H "Authorization: Bearer $CRIER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "usage": "api"
  }'

const res = await fetch('https://api.usecrier.com/v1/workspace', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "usage": "api"
  }),
});
const { data } = await res.json();

import os, requests

res = requests.patch(
    "https://api.usecrier.com/v1/workspace",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
    json={
        "usage": "api"
    },
)
data = res.json()["data"]