Team

Members and invitations. Owners and admins manage the team; members publish and answer.

List members and invitations

GET/v1/team

Response 200

data

• membersobject[]required
  members

  • userIdstringrequired
  • emailstring
  • rolestringrequired

    Values: owner · admin · member

  • joinedAtstring (date-time)required
  • youbooleanrequired
• invitationsobject[]required
  invitations

  • idstringrequired
  • emailstringrequired
  • rolestringrequired

    Values: admin · member

  • createdAtstring (date-time)required
  • expiresAtstring (date-time)required

curl

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

Node

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

Python

import os, requests

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

Invite someone

POST/v1/team/invitationsDashboard only

Returns a link to send to them. They join by signing in with the invited email.

Body

• emailstring (email)required

  Who to invite; they must sign in with this email to accept.

• rolestring

  admin manages the team, API keys and webhooks; member publishes and answers.

  Values: admin · memberDefault: "member"

Response 201

data

• invitationobjectrequired
  invitation

  • idstringrequired
  • emailstringrequired
  • rolestringrequired

    Values: admin · member

  • createdAtstring (date-time)required
  • expiresAtstring (date-time)required
• urlstring (uri)required

  The link to send. Shown only now; valid for 7 days.

curl

curl -X POST "https://api.usecrier.com/v1/team/invitations" \
  -H "Authorization: Bearer $CRIER_API_KEY"

Node

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

Python

import os, requests

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

Cancel an invitation

DELETE/v1/team/invitations/{id}Dashboard only

Parameters

• idstringrequired

Response 204

No content

curl

curl -X DELETE "https://api.usecrier.com/v1/team/invitations/inv_9n1m4l" \
  -H "Authorization: Bearer $CRIER_API_KEY"

Node

await fetch('https://api.usecrier.com/v1/team/invitations/inv_9n1m4l', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});

Python

import os, requests

requests.delete(
    "https://api.usecrier.com/v1/team/invitations/inv_9n1m4l",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)

Change a role

PATCH/v1/team/members/{userId}Dashboard only

Parameters

• userIdstringrequired

Body

• rolestringrequired

  Values: admin · member

Response 200

data

• userIdstringrequired
• emailstring
• rolestringrequired

  Values: owner · admin · member

• joinedAtstring (date-time)required
• youbooleanrequired

curl

curl -X PATCH "https://api.usecrier.com/v1/team/members/{userId}" \
  -H "Authorization: Bearer $CRIER_API_KEY"

Node

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

Python

import os, requests

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

Remove someone, or leave

DELETE/v1/team/members/{userId}Dashboard only

Parameters

• userIdstringrequired

Response 204

No content

curl

curl -X DELETE "https://api.usecrier.com/v1/team/members/{userId}" \
  -H "Authorization: Bearer $CRIER_API_KEY"

Node

await fetch('https://api.usecrier.com/v1/team/members/{userId}', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});

Python

import os, requests

requests.delete(
    "https://api.usecrier.com/v1/team/members/{userId}",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)

Accept an invitation

POST/v1/invitations/acceptDashboard only

Body

• tokenstringrequired

  The token in the invitation link.

  min 16max 200

Response 200

data

• workspaceIdstringrequired
• rolestringrequired

  Values: owner · admin · member

curl

curl -X POST "https://api.usecrier.com/v1/invitations/accept" \
  -H "Authorization: Bearer $CRIER_API_KEY"

Node

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

Python

import os, requests

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