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
| Name | Type | Required | Description |
|---|
limit | integer | No | Page size. Values above 100 are clamped. |
starting_after | string | No | Opaque cursor from a previous response’s next_cursor. |
updated_since | timestamp | No | Return records changed at or after this instant. Tracks the record itself, not its child collections. |
status | published · archived | No | Only articles in this state. Drafts are never listed. |
category_id | string | No | Only articles filed in this category. |
Responses
| Status | Meaning |
|---|
200 | A page of articles. |
401 | The API key is missing, malformed, revoked or expired. |
403 | The key does not carry the required scopes. |
429 | Rate limit exceeded. See the RateLimit-* headers. |
Retrieve an article
GET/v1/articles/{id}
Path parameters
| Name | Type | Required | Description |
|---|
id | string | Yes | The identifier returned as id on the object. |
Responses
| Status | Meaning |
|---|
200 | The article. |
401 | The API key is missing, malformed, revoked or expired. |
403 | The key does not carry the required scopes. |
404 | No such article in this workspace. |
429 | Rate limit exceeded. See the RateLimit-* headers. |