SparrowDesk
Articles

List all articles

GET
/articles

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

help_center_idinteger

Help center id (from GET /helpcenters)

published?boolean

Include published articles. Omit all three status flags to include every lifecycle bucket.

draft?boolean

Include draft and under-review articles.

archived?boolean

Include archived articles.

starting_after?string|null

Cursor for pagination (only needed for subsequent pages)

per_page?integer|null

Number of items per page (1-100, default 30)

Default30
Range1 <= value <= 100
search?string

Search title and body.

collection_id?integer

Restrict to a specific collection.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.sparrowdesk.com/v1/articles?help_center_id=994"
{
  "data": [
    {
      "id": 1001,
      "title": "Getting started with SparrowDesk",
      "slug": "getting-started-with-sparrowdesk",
      "status": "PUBLISHED",
      "draft_html_content": "<p>Work in progress…</p>",
      "published_html_content": "<p>Welcome to <strong>SparrowDesk</strong>.</p>",
      "is_public": true,
      "is_archived": false,
      "help_center": {
        "id": 994,
        "name": "Support"
      },
      "collection": {
        "id": 1021,
        "name": "Basics"
      },
      "brand": {
        "id": 1,
        "name": "Acme"
      },
      "created_by": {
        "id": 5,
        "name": "Jane Doe",
        "email": "[email protected]"
      },
      "last_updated_by": {
        "id": 6,
        "name": "John Roe",
        "email": "[email protected]"
      },
      "published_at": 1717236000,
      "created_at": 1714557600,
      "updated_at": 1717236000
    }
  ],
  "pages": {
    "per_page": 30,
    "next_cursor": "string",
    "next_url": "string"
  },
  "total_count": 42
}
{
  "error": {
    "message": "Invalid cursor"
  }
}
{
  "error": {
    "message": "Missing required scope or feature is not enabled"
  }
}
{
  "error": {
    "message": "Help center not found"
  }
}
{
  "error": {
    "message": "Select at least one of published, draft, or archived (they cannot all be false)"
  }
}
{
  "error": {
    "message": "An error occurred while retrieving articles"
  }
}