---
title: "List articles"
method: GET
path: "/v1/articles"
tags: ["Articles"]
---

# List articles

`GET /v1/articles`

## Request

- Base URL: `https://api.capacity.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.capacity.com/v1/articles`
- Auth: one of:
  - API key in header `x-capacity-id`
  - HTTP bearer

List articles. Results are paginated.

## Query parameters

- `page` integer
- `limit` integer
- `id_in` string[]
- `tag_id_in` string[]
- `tag_names` string[]
- `publish_start_date_after` string, date
- `publish_start_date_before` string, date
- `publish_expiration_date_after` string, date
- `publish_expiration_date_before` string, date
- `article_status_id_in` integer[]
- `approval_status_id_in` integer[]

## Response `200`

An array of Article objects

- object
  - `body` object: Json body data in the request
  - `limit` integer: Number of results returned
  - `page` integer: Page of results returned
  - `parameters` object: Query parameters in the request
  - `result` ArticleSchema[]
    - `approval_status_id` integer: ID for article's approval status. 1 = Pending Approval, 2 = Needs Revision, 3 = Approved
    - `article_status_id` integer: ID for article's publishing status. 1 = Draft, 3 = Published
    - `author_id` string: ID of user who created article
    - `body` string: Article body contents
    - `created_at` string: Datetime when article was created
    - `id` string: ID of article
    - `owner_user_id` string: ID of user who last updated article
    - `publish_expiration_date` string: Date/time at which article will automatically be unpublished
    - `publish_start_date` string: Date/time at which article is set to be published
    - `seo_meta_description` string
    - `seo_tags` string[]: Terms used for search engine optimization
    - `site_folder_id` string: ID of article's parent site folder
    - `site_id` string: ID of article's site
    - `slug` string: Slug used in article URL
    - `sort_index` integer: Index of article order in parent site folder
    - `summary` string: Article summary
    - `tag_ids` string[]: IDs of global tags applied to article
    - `tag_names` string[]: Names of global tags applied to article
    - `title` string: Article title
    - `updated_at` string: Datetime when article was last updated
    - `url_id` integer: Integer unique identifier for article

---

[API](https://skmtc.dev/capacity/apis/capacity-api-docs.md) - [All operations](https://skmtc.dev/capacity/apis/capacity-api-docs/llms.txt) - [OpenAPI document](https://skmtc.dev/capacity/apis/capacity-api-docs/revisions/74c85bb61004?raw)