COcodepen
Pens

List Pens

The key owner's Pens, filtered. Every filter given must match.

With block, a request scans at most 500 candidate Pens: the Link header has first and, while candidates remain, next with a cursor, but no last. Follow next until it is absent, even when the page is empty or X-CodePen-Partial is true.

get/v2/pens

Request

  • Base URL
    https://api.codepen.io
  • Auth
    • HTTP bearer
    • or API key in header X-API-Key

Query parameters

pageinteger

The page, from 1.

per_pageinteger

Items per page. A value over 100 is reduced to 100, not refused.

sort'created' | 'updated' | 'popularity' | 'title'

The order: by creation or update time, by popularity, or by title.

direction'asc' | 'desc'

desc, the default, lists newest first.

accessstring

Comma list of Public, Private, Protected and Collaborators.

deployedboolean

true for Pens with a live deployment, false for Pens without one.

templateboolean

true for Pens marked as templates, false for the rest.

forks'All' | 'Forked' | 'NotForked'

Forked for forks only, NotForked for Pens that are not forks.

editor'V2' | 'Classic'

V2, or Classic for Pens made in the classic editor.

tagsstring

Comma list of up to three tags; a Pen tagged with any of them matches. Tags are matched the way they are saved: lowercased, spaces as dashes, punctuation dropped.

search_termstring

Matches the title or description, up to 200 characters. Every word has to appear, "quoted words" stay together and -word excludes one.

created_sincestring date-time

Pens created since this time (RFC 3339).

created_untilstring date-time

Pens created until this time (RFC 3339).

updated_sincestring date-time

Pens updated since this time (RFC 3339).

updated_untilstring date-time

Pens updated until this time (RFC 3339).

untitledboolean

true for Pens with no title.

blockstring

Pens whose saved head uses this Block, such as sass-1. A capped scan; see the operation description.

cursorstring

With block only: the cursor from the next link. Not combined with page.

Response

A page of Pens.

access'Public' | 'Private' | 'Protected' | 'Collaborators' required

Public; Private (not listed on the site; anyone with the link can view it); Protected (private and password protected); Collaborators (private and for collaborators only). Anything but Public needs a PRO plan.

created_atstring date-time required
descriptionstring required
editor'Classic' | 'V2' required

V2, or Classic for a Pen made in the classic editor, which is read-only through the API.

idstring required

The cpid, or the hashid for a Pen made in the classic editor.

loves_countinteger required
passwordstring nullable required

Write-only, so always null.

popularityinteger required
tagsstring[] required
templateboolean required
titlestring required
updated_atstring date-time required
views_countinteger required

Views as the site shows them, tallied in batches, so it can trail by a few minutes.

Example response

[
  {
    "build": {
      "files": [
        {
          "name": "app.js",
          "path": "/src/app.js"
        }
      ]
    },
    "saved_version": {
      "build": {
        "files": [
          {
            "name": "app.js",
            "path": "/src/app.js"
          }
        ]
      },
      "files": [
        {
          "name": "app.js",
          "path": "/src/app.js"
        }
      ]
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.