> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration.

## This page

- **On-site (HTML):** <https://www.socialfetch.dev/docs/api/v1/shopify/blogs/bloghandle/articles/get>
- **Markdown (.mdx) URL:** <https://www.socialfetch.dev/docs/api/v1/shopify/blogs/bloghandle/articles/get.mdx>

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route).
- **OpenAPI JSON:** <https://www.socialfetch.dev/openapi.json>

## Recommended docs entrypoints (this site)

- [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown).
- [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope.
- [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages.
- [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples.
- [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths.
- [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install.
- [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 910 endpoint tools, plus docs_search/docs_read for implementation help.
- [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples.
- [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start.
- [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog.
- [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI).
- [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls).
- [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist.
- [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
- [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages.
- [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance.
- [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs.
- Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract.

## Markdown docs convention

- Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`).
- Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`).
- Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`).

---
# List Shopify blog articles (https://www.socialfetch.dev/docs/api/v1/shopify/blogs/bloghandle/articles/get)

## Summary

List the articles in one Shopify blog with full content, author and paging.

**Tags:** `Shopify`

## HTTP

- **Method:** GET
- **Path:** `/v1/shopify/blogs/{blogHandle}/articles`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.shopify.listArticles({ store: "www.allbirds.com", blogHandle: "news" })`
- **Accepted identifiers:** `blogHandle` (path)
- **Pagination:** cursor via `cursor`, next cursor: `data.page.nextCursor`, has more: `data.page.hasMore`
- **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`, `private`, `restricted`

## Credits

- **Base:** 1 credit per successful lookup.
- **Maximum on success (200):** 1 credit.
- **Failed requests (`lookup_failed`, `503`):** not charged.
- **Authoritative field:** `meta.creditsCharged`.

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `blogHandle` (path)

- **Required:** yes
- **Constraints:** type `string`; minLength: 1; maxLength: 255; pattern: `^[^\s/?#]+$`
- **Description:** The blog handle, as it appears in its URL, e.g. `news`.

### `store` (query)

- **Required:** yes
- **Constraints:** type `string`
- **Description:** The store's domain, for example `allbirds.com`, `www.allbirds.com` or `weareallbirds.myshopify.com`. A full URL is accepted and reduced to its host. Only public storefront hosts are accepted.

### `limit` (query)

- **Required:** no
- **Constraints:** type `integer`; minimum: 1; maximum: 250
- **Description:** Articles per page, 1 to 250. Default: 10.

### `cursor` (query)

- **Required:** no
- **Constraints:** type `string`; minLength: 1; maxLength: 4096
- **Description:** Cursor from `page.nextCursor` of the previous response. It only works with the same filters.

## Pagination

This endpoint uses **cursor-based pagination** via the `cursor` query parameter.

- Read **hasMore** from `data.page.hasMore`.
- When that value is `true`, read **nextCursor** from `data.page.nextCursor` and pass it as the `cursor` query parameter on the **next** request (URL-encode when building a query string).
- Omit `cursor` on the **first** request.
- Stop when **hasMore** is `false` or **nextCursor** is null (end of list).

## Responses (status codes)

- **200**: A page of Shopify blog articles.
- **400**: Invalid request
- **401**: Missing or invalid API key
- **402**: Insufficient credits
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed.
- **503**: Service temporarily unavailable; safe to retry with backoff.

## Response body (200)

A page of Shopify blog articles.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, not_found, private, restricted. `found` on success; `not_found` when it does not exist or is not a Shopify store; `private` when the storefront is password-protected; `restricted` when the store is paused or frozen.
  - **store** (required) — type `string`. The store host that was requested.
  - **blogHandle** (required) — type `string`. The blog handle that was requested.
  - **blog** (required) — type `object`; nullable. The blog when found; null otherwise.
    - **id** (required) — type `string`. Blog id.
    - **handle** (required) — type `string`. Blog handle.
    - **title** (required) — type `string`; nullable. Blog title.
  - **articles** (required) — type `array`. Articles on this page.
    - _items:_
      - **id** (required) — type `string`. Numeric article id as a string.
      - **gid** (required) — type `string`; nullable. The store's global article id.
      - **handle** (required) — type `string`. Article handle.
      - **title** (required) — type `string`. Article title.
      - **url** (required) — type `string`; nullable. Article URL.
      - **excerpt** (required) — type `string`; nullable. Excerpt as plain text.
      - **content** (required) — type `string`; nullable. Article text as plain text.
      - **contentHtml** (required) — type `string`; nullable. Article text as HTML.
      - **publishedAt** (required) — type `string`; nullable. Published, ISO 8601 UTC.
      - **tags** (required) — type `array`. Tags.
        - _items:_
          - type `string`
      - **seo** (required) — type `object`. The merchant's meta tags.
      - **author** (required) — type `object`. Who wrote it.
      - **image** (required) — type `object`; nullable. Article image; null when none.
      - **comments** (required) — type `array`. Moderated comments on the article, up to the page size.
        - _items:_
      - **commentsHasMore** (required) — type `boolean`. Whether the store has more comments than this page.
  - **page** (required) — type `object`. Pagination state for the current page.
    - **hasMore** (required) — type `boolean`. Whether another page is available.
    - **nextCursor** (required) — type `string`; nullable. Cursor for the next page; null on the last page.
- **meta** (required) — type `object`. Metadata describing the request and billing outcome.
  - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call.
  - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request.
  - **version** (required) — type `string`; enum: v1. Public API version that served the response.

### Example JSON (found)

```json
{
  "data": {
    "lookupStatus": "found",
    "store": "00bdaa.myshopify.com",
    "blogHandle": "news",
    "blog": {
      "id": "",
      "handle": "news",
      "title": null
    },
    "articles": [
      {
        "id": "558772453464",
        "gid": "gid://shopify/Article/558772453464",
        "handle": "setting-up-your-pedalboard",
        "title": "Setting Up Your Pedalboard",
        "url": "https://00bdaa.myshopify.com/blogs/news/setting-up-your-pedalboard",
        "excerpt": null,
        "content": "Setting up Your Pedalboard html { scroll-behavior: smooth; } .blogity--article li { margin: 1rem 0; } .blogity--article li p { display: inline; } .blogity-base-style { font-size: var(--blogity-base-font-size, 1rem); } .blogity-heading-styl…",
        "contentHtml": "<div class=\"blogity--article\">\n<h2 class=\"blogity--article\"><strong>Setting up Your Pedalboard</strong></h2>\n</div>\n<style>\n    \nhtml {\n  scroll-behavior: smooth;\n}\n\n.blogity--article li {\n  margin: 1rem 0;\n}\n\n.blogity--article li p {\n  di…",
        "publishedAt": "2024-06-17T19:55:43.000Z",
        "tags": [],
        "seo": {
          "title": "Setting Up Your Pedalboard - Heavy Metal FX",
          "description": " html { scroll-behavior: smooth; } .blogity--article li { margin: 1rem 0; } .blogity--article li p { display: inline; } .blogity-base-style {  - Heavy Metal FX"
        },
        "author": {
          "name": "Darren Chappuies",
          "bio": null
        },
        "image": null,
        "comments": [],
        "commentsHasMore": false
      }
    ],
    "page": {
      "hasMore": false,
      "nextCursor": null
    }
  },
  "meta": {
    "requestId": "req_01example_shopify_articles_openapi_200_example",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Machine-readable error codes

When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime):

- `bad_request`

## Error handling & retries

Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status.

- **400**: Invalid request **Retry:** Fix the request; retrying the same invalid payload will not help.
- **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help.
- **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help).
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed. **Retry:** May be transient; a few retries with backoff are reasonable.
- **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter.

### Suggested client defaults

- Send the API key using the `x-api-key` header on every request.
- On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user.
- On `402`, surface an actionable billing message rather than blind retries.

## Examples

### TypeScript SDK

```typescript
import { SocialFetchClient } from "@socialfetch/sdk";

const client = new SocialFetchClient({
  apiKey: process.env.SOCIALFETCH_API_KEY!,
});

const result = await client.shopify.listArticles({
  blogHandle: "news",
  store: "www.allbirds.com",
});

if (!result.ok) {
  console.error(result.error);
} else {
  console.log(result.value.data);
}
```

### Node.js

```javascript
const response = await fetch(
  "https://api.socialfetch.dev/v1/shopify/blogs/news/articles?store=www.allbirds.com",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/shopify/blogs/news/articles?store=www.allbirds.com" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/shopify/blogs/news/articles?store=www.allbirds.com",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```

### Example: next page (pagination)

After a successful response, if pagination is not finished, request the next page using `cursor` (URL-encode when composing the query string):

```javascript
const previous = await response.json();
const nextCursor = previous?.data?.page?.nextCursor;
const hasMore = previous?.data?.page?.hasMore;
if (!hasMore || nextCursor == null) {
  // no more pages
} else {
  const nextUrl = new URL("https://api.socialfetch.dev/v1/shopify/blogs/value/articles");
  nextUrl.searchParams.set("cursor", nextCursor);
  // optionally preserve sort: nextUrl.searchParams.set("sortBy", "latest");
  const nextResponse = await fetch(nextUrl.toString(), {
    headers: { "x-api-key": "YOUR_API_KEY" },
  });
  const nextData = await nextResponse.json();
}
```