CMS

List articles

Changed on

Returns a paginated list of articles for the team with status, SEO scores, publish dates, and metadata. Does not include full article body content.

get/v3/cms/articles

Request

  • Base URL: https://api.snowseo.com
  • URL: https://api.snowseo.com/v3/cms/articles
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Query parameters

teamIdstring

Team ID

selectionstring

JSON all-matching or explicit article-slug selection, resolved only for bulk actions.

pagestring

Page number (default: 1)

per_pagestring

Items per page (default: 20, or "all")

status'draft' | 'processing' | 'generated' | 'scheduled' | 'published' | 'failed' | 'manual' | 'all'

Filter by status (draft, processing, generated, scheduled, published, failed, manual) or "all"

topicIdstring

Filter to articles belonging to a topic cluster

startDatestring

ISO date - only articles whose scheduledAt or publishedAt is on/after this (calendar-window scoping)

endDatestring

ISO date - only articles whose scheduledAt or publishedAt is on/before this (calendar-window scoping)

searchstring

Case-insensitive search across title, slug, keywords, prompts, providers, and topic name

sortBy'name' | 'status' | 'seo' | 'topic' | 'created' | 'visitors'

Sort column

sortDir'asc' | 'desc'

Sort direction

analyticsProvider'ga' | 'posthog' | 'plausible' | 'snow'
analyticsStartDatestring date
analyticsEndDatestring date
categorystring

Filter to articles carrying this category name

tagstring

Filter to articles carrying this tag name

Response

Default Response

Changes

  • 7ede4ba45814Revision changes
    • info

      added the new optional query request parameter analyticsEndDate

    • info

      added the new optional query request parameter analyticsProvider

    • info

      added the new optional query request parameter analyticsStartDate

    • info

      added the new optional query request parameter selection

    • info

      added the new enum value visitors to the query request parameter sortBy

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

  • 78929b45c4f8Revision changes
    • warning

      added the new embed enum value to the /// response property for the response status