Documentation

Teams - How to list all Teams

Janis Kelemen — Fri, 12 Jun 2026 10:02:28 +0000

Request Overview

Actions

Returns

Description

GET /api/v1/teams

Collection

Get all teams

FieldsTeam Object

Field

Type

Required

Agents - How to list all Agents

Janis Kelemen — Fri, 12 Jun 2026 10:02:19 +0000

Request Overview

Actions

Returns

Description

GET /api/v1/agents

Collection

Get all teams

FieldsAgent Object

Field

Type

Required

Default Rate limit

Stefan Dreßler — Fri, 14 Jan 2022 11:12:59 +0000

In order to control the usage of our service, there is a rate limit of 30 requests per minute. Every request will expose the limitation and the remaining requests.

HTTP/1.1 200 OK X-RateLimit-Limit: 30 X-RateLimit-Remaining: 22 ... { "data": [ ... ], ... }

Requests are limited to 30 requests per minute per account. All users associated with the same account count...

Categories - How to list docs-categories

Stefan Dreßler — Thu, 08 Jan 2026 15:50:11 +0000

Request Overview

Actions

Returns

Description

GET /api/v1/docs/categories

Collection

Get all categories

FieldsCategory Object

Sites - How to list docs-sites

Stefan Dreßler — Thu, 08 Jan 2026 15:46:58 +0000

Request Overview

Actions

Returns

Description

GET /api/v1/docs/sites

Collection

Get all sites

FieldsSite Object

Webhook - How to view and edit your Webhook

Janis Kelemen — Fri, 04 Nov 2022 17:19:15 +0000

Request Overview

Actions

Returns

Description

GET /api/v1/webhook

Object

Get webhook

POST /api/v1/webhook

201 Object

Update webhook

Reports - How to get reports

Stefan Dreßler — Wed, 05 Mar 2025 12:00:00 +0000

Request Overview

Actions

Returns

Description

POST /api/v1/reports/channels

Object

Get channels report

POST /api/v1/reports/performance

Object

Get performance report

Messages - How to list, get and create ticket messages

Stefan Dreßler — Fri, 22 Apr 2022 12:29:09 +0000

Request Overview

Actions

Returns

Description

GET /api/v1/tickets/{id}/messages

Collection

Get all messages of a ticket

GET /api/v1/tickets/{id}/messages/{id}

Object

Get one ticket...

Introduction

Stefan Dreßler — Fri, 11 Feb 2022 19:51:17 +0000

Welcome to the HelpSpace API Documentation

Our JSON-REST API can be used to list, create, update and delete data objects in your HelpSpace Workspace. If you are not a customer yet, you can register for a test account on our website.

API Domain

All request should be sent to https://api.helpspace.com/api/v1/... The exact paths are shown in the examples on the following...

Access Tokens and Authentication - How to Authenticate & API Testing Tools Example

Stefan Dreßler — Fri, 04 Feb 2022 19:07:00 +0000

Before you start working with the HelpSpace API, you need to generate an API-Token. Please log in to your account and go to Settings -> Access Tokens. This token will be show one time only. Please save it to your password manager. If you lose it, you need to create a new token.

Tickets - How to list, create, get, update and delete tickets

Stefan Dreßler — Fri, 04 Feb 2022 15:50:00 +0000

Request Overview

Actions

Returns

Description

GET /api/v1/tickets

Collection

Get all tickets

POST /api/v1/tickets

201 Object

Create ticket

Tags - How to list, create, get, update and delete tags

Stefan Dreßler — Thu, 20 Jan 2022 14:37:20 +0000

Request Overview

Actions

Returns

Description

GET /api/v1/tags

Collection

Get all tags

POST /api/v1/tags

201 Object

Create tag

General Response Structure

Stefan Dreßler — Fri, 10 Sep 2021 21:20:17 +0000

The following article will give you a general structure of the expected behave and response objects. All communication is provided as JSON format.

Collection Request

Return status 200 and the requested collection

In case of a collection request, the general response structure is the following.

HTTP/1.1 200 OK Content-Type: application/json ... { "data": [ { ... }, ... ], "links": { ... },...

Customers - How to list, create, get, update and delete customers

Stefan Dreßler — Fri, 14 Jan 2022 11:14:01 +0000

Request Overview

Actions

Returns

Description

GET /api/v1/customers

Collection

Get all customers

POST /api/v1/customers

201 Object

Create customer

Articles - How to list and get articles

Stefan Dreßler — Thu, 08 Jan 2026 15:51:09 +0000

Request Overview

Actions

Returns

Description

GET /api/v1/docs/articles

Collection

Get all articles

GET /api/v1/docs/articles/{id}

200 Object

Get an article

Fields

Tasks - How to list, tasks

Stefan Dreßler — Tue, 13 May 2025 11:49:00 +0000

Request Overview

Actions

Returns

Description

GET /api/v1/scrum/tasks

Collection

Get all tasks

GET /api/v1/scrum/tasks/{id}

200 Object

Get a task

Webhooks Events - How to create and use webhooks in HelpSpace

Janis Kelemen — Fri, 11 Mar 2022 16:35:00 +0000

Webhooks are requests that are triggered by certain events in your HelpSpace workspace. Every webhook request contains information about the triggered event and the data of the item that has been changed.

Request Example

The data field always contains the API Response of the related object. In this example the ticket.created event has the ticket API Response described in

Widget Javascript API - Control your widget programmatically

Janis Kelemen — Fri, 29 Jan 2021 16:32:00 +0000

Loading our widget JavaScript library provides a few nifty methods to control the appearance and behavior of the widget programmatically. Placing the JavaScript snippet between your site's tags will automatically initialize and load your widget as soon as your website is fully loaded.

The async attribute is needed to load...

Zapier - Connect and create HelpSpace zaps with Zapier

Janis Kelemen — Fri, 13 Aug 2021 10:39:17 +0000

Zapier makes it easy to connect HelpSpace with over 3000 Apps, so you can build intelligent workflows and automations using the tools you work with.

Connect Zapier

Setting up the integration is fairly easy and described below with a few simple steps:

Click on “Setup Integration” on...

DeepL - How to translate your HelpSpace Docs into multiple languages

John Ibrügger — Fri, 06 Feb 2026 14:02:06 +0000

Docs pages in HelpSpace can be created in multiple languages. Each site has a primary language, which serves as the basis for translating the article and content into additional languages. To make translations fast and effortless, HelpSpace integrates with DeepL.

DeepL API key

DeepL offers both free and paid API keys.

Often, the free API key is...

branchly - How to Connect branchly with HelpSpace

John Ibrügger — Fri, 21 Feb 2025 16:28:07 +0000

Easily integrate the branchly Chat (GenAI Chatbot) with your HelpSpace knowledge base to provide customers with quick, accurate answers. This enhances customer satisfaction and reduces support workload. Your team can focus on complex inquiries, while straightforward questions are handled automatically. If personal support is needed, the request is seamlessly forwarded to HelpSpace and your support...

CentralStation CRM - How to Connect CentralStation CRM with HelpSpace

John Ibrügger — Fri, 21 Feb 2025 15:38:30 +0000

CentralStationCRM helps small companies, start-ups and the self-employed to maintain a good overview of their customer relationships. Service providers such as agencies, consultancies, and sales teams in particular can use CentralStationCRM to improve their B2B sales and keep track of their activities. Everyone can see at a glance which colleague last spoke to a customer,...

Xentral ERP - How to Connect Xentral ERP with HelpSpace

John Ibrügger — Thu, 12 Dec 2024 11:00:26 +0000

Integrating Xentral ERP with HelpSpace provides your agents with valuable customer insights directly in HelpSpace tickets. They can see whether the ticket sender is a Xentral customer, view their profile details, and seamlessly jump to Xentral to update data or review documents.

Step 1: Generate a Personal Access Token in Xentral

Log...

Shopify - How to Connect Shopify with HelpSpace

Janis Kelemen — Wed, 19 Apr 2023 16:05:16 +0000

Shopify can be integrated into HelpSpace easily. Customer information like orders will be displayed in the ticket context.

Shopify Sidebar in Tickets

If you connected your Shopify Shop you will see a small Shopify icon on top of the Ticket sidebar.

The Icon indicates to states:
1. Shopify Icon is gray - No Customer found in Your...

Payload Signature

Janis Kelemen — Fri, 11 Mar 2022 16:35:32 +0000

In order to verify that the payload has not been tempered with when you received the webhook, you can use the payload of the request and your secret to calculate the signature and compare it with the one in the signature header of the request.

// Payload is the post request body. // Secret is set in your webhook settings. $payloadJson...