Skip to main content

Knowledge base

The articles HR publishes for the workspace, as readers see them: the published title, summary and body (sanitised HTML), the category, tags and the version, which moves on every publish that changes the content. An edit in progress is never exposed and drafts are never listed. Who can read an article is decided by an audience the API does not expose, so target_type is as much as this tells you about distribution.

List articles​

GET/v1/articles

Query parameters​

NameTypeRequiredDescription
limitintegerNoPage size. Values above 100 are clamped.
starting_afterstringNoOpaque cursor from a previous response’s next_cursor.
updated_sincetimestampNoReturn records changed at or after this instant. Tracks the record itself, not its child collections.
statuspublished · archivedNoOnly articles in this state. Drafts are never listed.
category_idstringNoOnly articles filed in this category.

Responses​

StatusMeaning
200A page of articles.
401The API key is missing, malformed, revoked or expired.
403The key does not carry the required scopes.
429Rate limit exceeded. See the RateLimit-* headers.

Retrieve an article​

GET/v1/articles/{id}

Path parameters​

NameTypeRequiredDescription
idstringYesThe identifier returned as id on the object.

Responses​

StatusMeaning
200The article.
401The API key is missing, malformed, revoked or expired.
403The key does not carry the required scopes.
404No such article in this workspace.
429Rate limit exceeded. See the RateLimit-* headers.