v1

latestOpenAPI 3.0.2GNU AGPLv32026-07-245983524.8 KB
Sheets

Returns all of a specific user's public Sheets, paginated and sorted. Same response shape as the unparameterized variant.

get/api/sheets/user/{user_id}/{sort_by}/{limiter}/{offset}

Path parameters

user_idinteger required

Numeric user ID. To find it, call GET /api/profile/{slug} with the user's profile slug and read the id field from the response.

sort_by'date' | 'views' required

Sort key. date orders by most recent modification; views orders by view count.

limiterinteger required

Maximum number of sheets to return.

offsetinteger required

Offset into the result set, used for pagination.

Response

Successful Response

Example response

{
  "sheets": [
    {
      "owner": 65000,
      "_id": "5ec3a6f7c73d4d278311782e",
      "id": "238181",
      "public": true,
      "title": "סדר תיקון ליל שבועות",
      "sheetUrl": "/sheets/238181",
      "anchorRef": "Deuteronomy 1",
      "anchorRefExpanded": [
        "Deuteronomy 1:2"
      ],
      "options": {
        "numbered": 0,
        "boxed": 0,
        "assignable": 0,
        "bsd": 1,
        "language": "hebrew",
        "layout": "stacked",
        "langLayout": "heRight",
        "divineNames": "ykvk",
        "highlightMode": 0,
        "collaboration": "none"
      },
      "ownerName": "יותם גונן",
      "ownerProfileUrl": "/profile/-2977",
      "ownerImageUrl": "https://storage.googleapis.com/sefaria-profile-pictures/-2977-1626800304-small.png",
      "status": "public",
      "views": 8509,
      "topics": [],
      "likes": [],
      "summary": "",
      "is_featured": false,
      "category": "Sheets",
      "type": "sheet"
    }
  ]
}