REST API reference

Teams & teammates

Who’s on your team: teammates with their roles and teams, for assignment and reporting.

Use teammate ids as teammateId, assigneeId or ownerId in other endpoints, and team ids as teamId. Both need teams:read. Teams and teammates are managed in the dashboard.

The team object

A team inbox with its assignment method.

Fields

object string: Always team.
id string: Unique id.
name string: Team name.
emoji string | null: Icon.
description string | null: What the team handles.
assignmentMethod enum: manual, round_robin or balanced (fewest open conversations first).
teammateIds string[]: Members.

Example team

{  "object": "team",  "id": "0199a8f2-4f5a-7b6c-9d7e-8f9a0b1c2d3e",  "name": "Billing",  "emoji": "💳",  "description": "Invoices, refunds and plan changes.",  "assignmentMethod": "round_robin",  "teammateIds": [    "0199a8f2-2d3e-7f4a-9b5c-6d7e8f9a0b1c",    "0199a8f2-3e4f-7a5b-8c6d-7e8f9a0b1c2d"  ]}

The teammate object

A member of the workspace.

Fields

object string: Always teammate.
id string: Unique id.
name string: Full name.
email string: Sign-in email.
avatarUrl string | null: Photo.
role enum: owner, admin, agent or viewer (read-only).
status enum: active or away (away teammates get no new assignments).
title string | null: Job title.
teamIds string[]: Teams they belong to.

Example teammate

{  "object": "teammate",  "id": "0199a8f2-3e4f-7a5b-8c6d-7e8f9a0b1c2d",  "name": "Jonas Weber",  "email": "[email protected]",  "avatarUrl": null,  "role": "agent",  "status": "active",  "title": "Billing specialist",  "teamIds": [    "0199a8f2-4f5a-7b6c-9d7e-8f9a0b1c2d3e"  ]}

List teams

GET /v1 /teams teams:read

Every team. Not paginated. GET /teams/{id} returns one.

curl https://api.rabbitblaze.com/v1/teams \  -H "Authorization: Bearer $RABBITBLAZE_API_KEY"

const res = await fetch("https://api.rabbitblaze.com/v1/teams", {  headers: {    Authorization: `Bearer ${process.env.RABBITBLAZE_API_KEY}`,  },})const data = await res.json()

import osimport requests res = requests.get(    "https://api.rabbitblaze.com/v1/teams",    headers={"Authorization": f"Bearer {os.environ['RABBITBLAZE_API_KEY']}"},)res.raise_for_status()data = res.json()

Response · 200 OK

{  "items": [    {      "object": "team",      "id": "0199a8f2-4f5a-7b6c-9d7e-8f9a0b1c2d3e",      "name": "Billing",      "emoji": "💳",      "description": "Invoices, refunds and plan changes.",      "assignmentMethod": "round_robin",      "teammateIds": [        "0199a8f2-2d3e-7f4a-9b5c-6d7e8f9a0b1c",        "0199a8f2-3e4f-7a5b-8c6d-7e8f9a0b1c2d"      ]    }  ],  "nextCursor": null}

List teammates

GET /v1 /teammates teams:read

Everyone in the workspace. Not paginated.

curl https://api.rabbitblaze.com/v1/teammates \  -H "Authorization: Bearer $RABBITBLAZE_API_KEY"

const res = await fetch("https://api.rabbitblaze.com/v1/teammates", {  headers: {    Authorization: `Bearer ${process.env.RABBITBLAZE_API_KEY}`,  },})const data = await res.json()

import osimport requests res = requests.get(    "https://api.rabbitblaze.com/v1/teammates",    headers={"Authorization": f"Bearer {os.environ['RABBITBLAZE_API_KEY']}"},)res.raise_for_status()data = res.json()

Response · 200 OK

{  "items": [    {      "object": "teammate",      "id": "0199a8f2-3e4f-7a5b-8c6d-7e8f9a0b1c2d",      "name": "Jonas Weber",      "email": "[email protected]",      "avatarUrl": null,      "role": "agent",      "status": "active",      "title": "Billing specialist",      "teamIds": [        "0199a8f2-4f5a-7b6c-9d7e-8f9a0b1c2d3e"      ]    }  ],  "nextCursor": null}

Retrieve a teammate

GET /v1 /teammates/{id} teams:read

One teammate by id.

Path parameters

id string required: The teammate id.

curl https://api.rabbitblaze.com/v1/teammates/0199a8f2-3e4f-7a5b-8c6d-7e8f9a0b1c2d \  -H "Authorization: Bearer $RABBITBLAZE_API_KEY"

const res = await fetch("https://api.rabbitblaze.com/v1/teammates/0199a8f2-3e4f-7a5b-8c6d-7e8f9a0b1c2d", {  headers: {    Authorization: `Bearer ${process.env.RABBITBLAZE_API_KEY}`,  },})const data = await res.json()

import osimport requests res = requests.get(    "https://api.rabbitblaze.com/v1/teammates/0199a8f2-3e4f-7a5b-8c6d-7e8f9a0b1c2d",    headers={"Authorization": f"Bearer {os.environ['RABBITBLAZE_API_KEY']}"},)res.raise_for_status()data = res.json()

Response · 200 OK

{  "object": "teammate",  "id": "0199a8f2-3e4f-7a5b-8c6d-7e8f9a0b1c2d",  "name": "Jonas Weber",  "email": "[email protected]",  "avatarUrl": null,  "role": "agent",  "status": "active",  "title": "Billing specialist",  "teamIds": [    "0199a8f2-4f5a-7b6c-9d7e-8f9a0b1c2d3e"  ]}