SupportBee

SupportBee integration (Communication, Productivity). Imported from open-connector.

API key15 toolshttps://{company}.supportbee.com

GET

supportbee_list_tickets

List SupportBee tickets with optional official ticket filters.

/tickets

15 parameters

Param	Type	Required	Description
per_page	integer	optional	The number of records to retrieve. SupportBee requires this to be less than 100.
page	integer	optional	The one-based SupportBee page number to retrieve.
archived	string	optional	How SupportBee should include archived tickets: true, false, or any.
spam	boolean	optional	Whether SupportBee should include tickets marked as spam.
trash	boolean	optional	Whether SupportBee should include trashed tickets.
replies	boolean	optional	Whether SupportBee should return only tickets with replies or only tickets with…
max_replies	integer	optional	The exact number of replies a ticket must have.
assigned_user	string	optional	SupportBee assigned_user filter such as me, any, none, or an agent ID.
assigned_team	string	optional	SupportBee assigned_team filter such as mine, none, or a team ID.
label	string	optional	The SupportBee label name used to filter tickets.
since	string	optional	A SupportBee date, date-time, or timestamp lower bound for ticket activity.
until	string	optional	A SupportBee date, date-time, or timestamp upper bound for ticket activity.
sort_by	string	optional	The SupportBee ticket sort mode.
requester_emails	array	optional	Email addresses sent to SupportBee.
total_only	boolean	optional	Whether SupportBee should return only the total ticket count.

GET

supportbee_search_tickets

Search SupportBee tickets by query text with optional pagination filters.

/tickets/search

5 parameters

Param	Type	Required	Description
query	string	required	The SupportBee ticket search query.
per_page	integer	optional	The number of records to retrieve. SupportBee requires this to be less than 100.
page	integer	optional	The one-based SupportBee page number to retrieve.
spam	boolean	optional	Whether SupportBee should include tickets marked as spam.
trash	boolean	optional	Whether SupportBee should include trashed tickets.

GET

supportbee_get_ticket

Retrieve a SupportBee ticket by ID.

/tickets/{id}

1 parameter

Param	Type	Required	Description
id	integer	required	A positive SupportBee numeric identifier.

POST

supportbee_create_ticket

Create a SupportBee ticket with JSON body content and optional email recipients.

/tickets

10 parameters

Param	Type	Required	Description
subject	string	optional	The subject of the ticket.
requester_name	string	optional	The name of the ticket requester.
requester_email	string	optional	The email address of the ticket requester.
cc	array	optional	Email addresses sent to SupportBee.
bcc	array	optional	Email addresses sent to SupportBee.
notify_requester	boolean	optional	Whether SupportBee should email a copy of the ticket to the requester, CC, and …
text	string	optional	The plain-text ticket body. Either text or html must be provided.
html	string	optional	The HTML ticket body. Either text or html must be provided.
attachment_ids	array	optional	SupportBee attachment IDs that were already uploaded through the SupportBee att…
forwarding_address_id	string	optional	The SupportBee forwarding address ID used as the sender for ticket copies or au…

GET

supportbee_list_ticket_replies

List replies for a SupportBee ticket.

/tickets/{ticket_id}/replies

1 parameter

Param	Type	Required	Description
ticket_id	integer	required	A positive SupportBee numeric identifier.

GET

supportbee_get_ticket_reply

Retrieve one SupportBee ticket reply by ticket ID and reply ID.

/tickets/{ticket_id}/replies/{reply_id}

2 parameters

Param	Type	Required	Description
ticket_id	integer	required	A positive SupportBee numeric identifier.
reply_id	integer	required	A positive SupportBee numeric identifier.

POST

supportbee_create_ticket_reply

Create a SupportBee ticket reply with JSON body content.

/tickets/{ticket_id}/replies

7 parameters

Param	Type	Required	Description
ticket_id	integer	required	A positive SupportBee numeric identifier.
text	string	optional	The plain-text reply body. Either text or html must be provided.
html	string	optional	The HTML reply body. Either text or html must be provided.
cc	array	optional	Email addresses sent to SupportBee.
bcc	array	optional	Email addresses sent to SupportBee.
attachment_ids	array	optional	SupportBee attachment IDs that were already uploaded through the SupportBee att…
on_behalf_of	object	optional	The SupportBee agent to reply on behalf of. Admin rights are required upstream.

GET

supportbee_list_ticket_comments

List comments for a SupportBee ticket.

/tickets/{ticket_id}/comments

1 parameter

Param	Type	Required	Description
ticket_id	integer	required	A positive SupportBee numeric identifier.

POST

supportbee_create_ticket_comment

Create a SupportBee ticket comment with JSON body content.

/tickets/{ticket_id}/comments

3 parameters

Param	Type	Required	Description
ticket_id	integer	required	A positive SupportBee numeric identifier.
text	string	optional	The plain-text comment body. Either text or html must be provided.
html	string	optional	The HTML comment body. Either text or html must be provided.

GET

supportbee_list_labels

List custom SupportBee labels for the connected desk.

/labels

POST

supportbee_add_label_to_ticket

Add an existing SupportBee label to a ticket.

/tickets/{ticket_id}/labels/{label_name}

2 parameters

Param	Type	Required	Description
ticket_id	integer	required	A positive SupportBee numeric identifier.
label_name	string	required	The existing SupportBee label name to add.

DELETE

supportbee_remove_label_from_ticket

Remove a SupportBee label from a ticket.

/tickets/{ticket_id}/labels/{label_name}

2 parameters

Param	Type	Required	Description
ticket_id	integer	required	A positive SupportBee numeric identifier.
label_name	string	required	The SupportBee label name to remove.

GET

supportbee_list_users

List SupportBee users and customer groups.

/users

3 parameters

Param	Type	Required	Description
with_invited	boolean	optional	Whether SupportBee should include invited users.
with_roles	array	optional	Role names SupportBee should include, sent as a comma-separated with_roles quer…
type	string	optional	The SupportBee user type filter.

GET

supportbee_get_user

Retrieve one SupportBee user or customer group by ID.

/users/{id}

2 parameters

Param	Type	Required	Description
id	integer	required	A positive SupportBee numeric identifier.
max_tickets	integer	optional	The maximum number of tickets SupportBee should include for the user, or false …

GET

supportbee_list_teams

List SupportBee teams with optional user expansion filters.

/teams

2 parameters

Param	Type	Required	Description
with_users	boolean	optional	Whether SupportBee should include users in each team.
user	string	optional	The SupportBee user filter. Official docs currently support me.