Public routes: Public help center

The help center’s public articles, for a web page with no signed-in user.

What it does	Route
Search the public articles	GET /public/v1/help/articles
Read a public article	GET /public/v1/help/articles/{slug}
Say whether a public article helped	POST /public/v1/help/articles/{slug}/rating
Fetch an article’s picture	GET /public/v1/help/assets/{asset_id}
List the public collections	GET /public/v1/help/collections
Read a public collection	GET /public/v1/help/collections/{slug}

Search the public articles

GET /public/v1/help/articles

Needs: the app key (X-CRM-App-Key, or ?app=). No sign-in.

Parameters

Name	In	Description
app	query	The app’s public key, for a request that cannot send the X-CRM-App-Key header.
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
404	problem	Not found, or the part is switched off.
429	problem	Too many requests: wait for Retry-After.

Read a public article

GET /public/v1/help/articles/{slug}

Needs: the app key (X-CRM-App-Key, or ?app=). No sign-in.

Parameters

Name	In	Description
slug (required)	path	The article’s or collection’s slug.
app	query	The app’s public key, for a request that cannot send the X-CRM-App-Key header.
lang	query	A language to read in (a BCP 47 tag), instead of the user’s own.

Answers

Status	Body	Meaning
200	Article	OK
404	problem	Not found, or the part is switched off.
429	problem	Too many requests: wait for Retry-After.

Say whether a public article helped

POST /public/v1/help/articles/{slug}/rating

From a reader with no account: their own id for the page, kept apart from every user’s.

Needs: the app key (X-CRM-App-Key, or ?app=). No sign-in.

Parameters

Name	In	Description
slug (required)	path	The article’s or collection’s slug.
app	query	The app’s public key, for a request that cannot send the X-CRM-App-Key header.

Body (application/json): PublicRatingBody

Field	Type	Description
helpful (always)	boolean
language	string	The language the reader read it in (Article.Language), for the help report; left out, the app’s default.
visitor (always)	string

Answers

Status	Body	Meaning
204	none	Done, with nothing to say
404	problem	Not found, or the part is switched off.
429	problem	Too many requests: wait for Retry-After.

Fetch an article’s picture

GET /public/v1/help/assets/{asset_id}

A redirect to the picture’s short-lived address.

Needs: nothing: no credential.

Parameters

Name	In	Description
asset_id (required)	path	The picture’s id.

Answers

Status	Body	Meaning
302	none	A redirect
404	problem	Not found, or the part is switched off.
429	problem	Too many requests: wait for Retry-After.

List the public collections

GET /public/v1/help/collections

Only articles marked public and meant for everyone. Name the app with the X-CRM-App-Key header, or with ?app= where a header cannot be sent.

Needs: the app key (X-CRM-App-Key, or ?app=). No sign-in.

Parameters

Name	In	Description
app	query	The app’s public key, for a request that cannot send the X-CRM-App-Key header.
lang	query	A language to read in (a BCP 47 tag), instead of the user’s own.

Answers

Status	Body	Meaning
200	Collections	OK
404	problem	Not found, or the part is switched off.
429	problem	Too many requests: wait for Retry-After.

Read a public collection

GET /public/v1/help/collections/{slug}

Needs: the app key (X-CRM-App-Key, or ?app=). No sign-in.

Parameters

Name	In	Description
slug (required)	path	The article’s or collection’s slug.
app	query	The app’s public key, for a request that cannot send the X-CRM-App-Key header.
lang	query	A language to read in (a BCP 47 tag), instead of the user’s own.

Answers

Status	Body	Meaning
200	CollectionArticles	OK
404	problem	Not found, or the part is switched off.
429	problem	Too many requests: wait for Retry-After.