Guest API: Help center
Your articles and collections, read and searched by a signed-in user.
| What it does | Route |
|---|---|
| Search the help center | GET /guest/v1/articles |
| Read an article | GET /guest/v1/articles/{slug} |
| Say whether an article helped | POST /guest/v1/articles/{slug}/rating |
| List the help center’s collections | GET /guest/v1/collections |
| Read a collection | GET /guest/v1/collections/{slug} |
Search the help center
Section titled “Search the help center”GET /guest/v1/articles
Articles whose words match q, best first; with no q, the most read.
Needs: the app key (X-CRM-App-Key) and the signed-in user’s token (Authorization: Bearer …), or their id for an app with unverified sign-in. See From a website or web app.
Parameters
| Name | In | Description |
|---|---|---|
lang | query | A language to read in (a BCP 47 tag), instead of the user’s own. |
limit | query | How many to answer, at most. |
q | query | Words to search for. |
Answers
| Status | Body | Meaning |
|---|---|---|
| 200 | Articles | OK |
| 400 | problem | The request could not be read: the problem names the field. |
| 401 | problem | No credential, or one that is not right. |
| 403 | problem | Refused: the app is switched off, or this is not allowed. |
| 404 | problem | Not found, or the part is switched off. |
| 429 | problem | Too many requests: wait for Retry-After. |
Read an article
Section titled “Read an article”GET /guest/v1/articles/{slug}
Needs: the app key (X-CRM-App-Key) and the signed-in user’s token (Authorization: Bearer …), or their id for an app with unverified sign-in. See From a website or web app.
Parameters
| Name | In | Description |
|---|---|---|
slug (required) | path | The article’s or collection’s slug. |
lang | query | A language to read in (a BCP 47 tag), instead of the user’s own. |
Answers
| Status | Body | Meaning |
|---|---|---|
| 200 | Article | OK |
| 400 | problem | The request could not be read: the problem names the field. |
| 401 | problem | No credential, or one that is not right. |
| 403 | problem | Refused: the app is switched off, or this is not allowed. |
| 404 | problem | Not found, or the part is switched off. |
| 429 | problem | Too many requests: wait for Retry-After. |
Say whether an article helped
Section titled “Say whether an article helped”POST /guest/v1/articles/{slug}/rating
Needs: the app key (X-CRM-App-Key) and the signed-in user’s token (Authorization: Bearer …), or their id for an app with unverified sign-in. See From a website or web app.
Parameters
| Name | In | Description |
|---|---|---|
slug (required) | path | The article’s or collection’s slug. |
Body (application/json): ArticleRatingBody
| Field | Type | Description |
|---|---|---|
helpful (always) | boolean |
Answers
| Status | Body | Meaning |
|---|---|---|
| 204 | none | Done, with nothing to say |
| 400 | problem | The request could not be read: the problem names the field. |
| 401 | problem | No credential, or one that is not right. |
| 403 | problem | Refused: the app is switched off, or this is not allowed. |
| 404 | problem | Not found, or the part is switched off. |
| 429 | problem | Too many requests: wait for Retry-After. |
List the help center’s collections
Section titled “List the help center’s collections”GET /guest/v1/collections
Needs: the app key (X-CRM-App-Key) and the signed-in user’s token (Authorization: Bearer …), or their id for an app with unverified sign-in. See From a website or web app.
Parameters
| Name | In | Description |
|---|---|---|
lang | query | A language to read in (a BCP 47 tag), instead of the user’s own. |
Answers
| Status | Body | Meaning |
|---|---|---|
| 200 | Collections | OK |
| 400 | problem | The request could not be read: the problem names the field. |
| 401 | problem | No credential, or one that is not right. |
| 403 | problem | Refused: the app is switched off, or this is not allowed. |
| 404 | problem | Not found, or the part is switched off. |
| 429 | problem | Too many requests: wait for Retry-After. |
Read a collection
Section titled “Read a collection”GET /guest/v1/collections/{slug}
A collection and its articles, in the user’s language.
Needs: the app key (X-CRM-App-Key) and the signed-in user’s token (Authorization: Bearer …), or their id for an app with unverified sign-in. See From a website or web app.
Parameters
| Name | In | Description |
|---|---|---|
slug (required) | path | The article’s or collection’s slug. |
lang | query | A language to read in (a BCP 47 tag), instead of the user’s own. |
Answers
| Status | Body | Meaning |
|---|---|---|
| 200 | CollectionArticles | OK |
| 400 | problem | The request could not be read: the problem names the field. |
| 401 | problem | No credential, or one that is not right. |
| 403 | problem | Refused: the app is switched off, or this is not allowed. |
| 404 | problem | Not found, or the part is switched off. |
| 429 | problem | Too many requests: wait for Retry-After. |