Skip to main content
GET
List articles

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

offset
number
default:0
Required range: x >= 0
limit
number
default:20
Required range: 1 <= x <= 100

Filter by title or description substring, case-insensitive. Use this to check whether an article on a subject already exists before writing a new one.

Example:

"screen recording"

slug
string

Filter by slug substring, case-insensitive. A full slug matches exactly one article, since slugs are unique per workspace, and a partial one matches every article whose slug contains it.

Use this to go from a published URL back to its article: pass the last path segment. Matching on a substring rather than the whole string means a trailing slash, a file extension or a date prefix in the URL path does not stop it resolving.

Example:

"how-to-start-a-blog"

indexed
boolean

Filter by whether Google has indexed the page. false is the set worth acting on: pages that are live but invisible in search. Combine with status=published, since an article that never reached your site cannot be indexed and would otherwise pad the results.

status
enum<string>

Filter by status

Available options:
draft,
generating,
generated,
published
categoryId
string

Filter by category ID

Response

200 - application/json
data
object