Skip to main content
GET
List all articles
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
default:your-api-key
required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Query Parameters

category_id
string<uuid>

Unique identifier of the category. Refer to Getting the Category ID section for detailed instructions.

page_number
integer

Retrieve paginated results by specifying the desired page number. Defaulting to 1 when omitted.

page_size
integer

Set the number of results returned in the response. Defaulting to 30 when omitted.

search_term
string

Search term to filter articles.

state
enum<string>

Status of the article.

Available options:
draft,
published

Response

200 - application/json

OK - Request succeeded

articles
object[]
pagination
object