Skip to main content
Use Supportbee through Corsair: one client, typed API calls. Every SupportBee desk is its own subdomain, so there is no shared API host. Set supportbee({ company: 'acme' }) or store it with keys.set_company(company). The host on its own (acme.supportbee.com) and a pasted desk address (https://acme.supportbee.com/tickets) are accepted too. Requests only go to https://<company>.supportbee.com: another domain, an IP address or a port is rejected before anything is sent. Without a company the plugin throws before it sends anything. Credentials are one API token, found on the desk under the profile picture, then API Token. Store it as the account’s api_key, or pass it as supportbee({ key }). Things to know before you call:
  • Every request needs Accept: application/json, which the client sends. Without it the desk answers HTML.
  • Ticket search takes query, not q. The route is /tickets/search, and a blank query is rejected before the request.
  • tickets.delete only works on a trashed ticket, and only an admin can call it. Trash first, then delete.
  • The list route answers unarchived tickets only unless archived names another scope, and it returns 15 tickets a page in last-activity order.
  • A reply leaves SupportBee. replies.create mail reaches the real customer; comments.create is the internal note only staff see.
  • A ticket takes a user assignee or a team assignee, not both. Reassigning to another team clears the user assignee.
  • A filter is three calls. filters.createRule and filters.createConsequence each return an id, and filters.create links them. Until the link exists, nothing happens.
  • emails manages forwarding addresses, not mail. SupportBee generates the forward_to address an existing mailbox forwards into.
  • The flag routes answer 204 with no body, so the plugin reports { id, updated: true } rather than returning nothing.
  • A customer group is a user with type: customer_group, and its members are added with users.addMember. There is no route to remove a member.
What you get:
  • 50 typed API operations

Setup

1

Install

2

Add the plugin

corsair.ts
With multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.
3

Choose authentication

4

Connect a tenant

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.

Example API calls

List recent tickets
Reply to a ticket
See the full list on the API page.

What’s next

API reference

Every supportbee.api.* operation with input and output types.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.