Workspace

Tu workspace y quién está llamando.

Quién llama

GET/v1/me

Respuesta 200

data

workspaceIdstringobligatorio
userobject | nullobligatorio
Null si llamas con una API key.
user
- userIdstringobligatorio
- emailstring
rolestring | nullobligatorio
El rol de quien usa el panel; null con una API key.
Valores: 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"]

Ver el workspace

GET/v1/workspace

Respuesta 200

data

idstringobligatorio
namestringobligatorio
usagestring | nullobligatorio
Valores: api · self
requireApprovalbooleanobligatorio
Las publicaciones de los miembros esperan a que un propietario o admin las apruebe.
createdAtstring (date-time)obligatorio

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"]

Editar el workspace

PATCH/v1/workspaceSolo desde el panel

Cuerpo

namestring
máx. 100
usagestring
Valores: api · self
requireApprovalboolean
Las publicaciones de los miembros esperan a que un propietario o admin las apruebe.

Respuesta 200

data

idstringobligatorio
namestringobligatorio
usagestring | nullobligatorio
Valores: api · self
requireApprovalbooleanobligatorio
Las publicaciones de los miembros esperan a que un propietario o admin las apruebe.
createdAtstring (date-time)obligatorio

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"]