Search the help centre, or read one article

GET


          /api/v1/support/articles/{article}

Try it

R Read

Scope read:support

Description

With no articleId: returns {data:[{id, title, slug, keyword, category, url}], has_more, next_cursor, total}, filtered by search. With an articleId: returns that one article plus its body.

Path parameters

Name	Type	Description
`article` required	string

Query parameters

Name	Type	Description
`article_id`	integer	An article id from `data[].id` to fetch that one article with its full body. Omit to search/list instead.
`search`	string	A search term matched against article titles and keywords, e.g. `email`, `ssl`, `dns`.
`locale`	string	Restrict to one locale, e.g. `sv` or `en`.
`limit`	integer	Page size for a collection. Range 1–100.
`cursor`	integer	Opaque pagination cursor. Pass back the previous response’s `nextCursor`; stop when it is null. Minimum 0.

Responses

The specification does not describe this response body; the note in the rail says what to expect. Every non-2xx response is an RFC 7807 problem with a stable code.

Commonly returned errors

The codes this operation reaches on its own path: the auth stack, its own validation and ownership checks, and the transport. Not a closed set — a shared code from the full registry can still surface. Each links to the code’s own page, the same URL its type dereferences to.

400

invalid_request

401 No token was presented, or the token is revoked, expired or unknown.

unauthorizedtoken_expiredtoken_revoked

403 The token lacks a required scope, or this account does not own the resource.

insufficient_scopenot_owned

404 No such resource for this account.

not_found

422 Validation error

validation_failed

429 The rate limit for this token is exhausted. See `Retry-After`.

rate_limited

500 Something went wrong on our side. The failure is logged against `requestId`.

internal_error