Sign in

v1

latestOpenAPI 3.0.2GNU AGPLv32026-07-245983524.8 KB
Sheets

Returns public Sheets that cite a given Sefaria ref.

get/api/sheets/ref/{ref}

Path parameters

refstring required

Sefaria ref. A Sefaria ref is a human-readable text citation, e.g. Genesis 1:1, Berakhot 2a, or Rashi on Genesis 1:1. Use dots for section separators in the URL.

Response

Successful Response

ownerinteger

the Sefaria User ID of the sheet's owner.

idstring

The id of the sheet. This is used in the URL to retrieve sheets, for example, a sheet with an id of 1, would be accessible on Sefaria at sefaria.org/sheets/1.

publicboolean

Is this sheet public.

titlestring

Title of the Source Sheet.

sheetUrlstring nullable

URL to this source sheet.

anchorRefstring

A string representing a citation to a Jewish text.

A valid Ref consists of a title string followed optionally by a section string or a segment string.

A title string is any one of the known text titles or title variants in the Sefaria Database.

anchorRefExpandedRef[] nullable

An array containing the individual segments Refs which comprise the anchorRef.

Example 1: Ranged Ref If the anchorRef is Genesis 2:14-16, the anchorRefExpanded is ["Genesis 2:14", "Genesis 2:15", "Genesis 2:16"].

Example 2: Segment Ref If the anchorRef itself is a segment Ref, the anchorRefExpanded will contain that identical value. For example, anchorRef of Genesis 2:11 will have an anchorRefExpanded of ["Genesis 2:11"]

collectionTOCobject nullable
ownerNamestring nullable

Name of the owner of the sheet.

viastring nullable

Some source sheets are made by copying another users. If this is one of them, the original owner's user ID will be listed here.

viaOwnerNamestring nullable

Some source sheets are made by copying another users. If this is one of them, the original owner's display name will be listed here.

assignerNamestring nullable

Some source sheets are created as assignments by a teacher to be completed by students. If this is one of those sheets the name of the assigner will be found here.

viaOwnerProfileUrlstring nullable

Some source sheets are made by copying another users. If this is one of them, the path to the original owner's profile page will be listed here.

assignerProfileUrlstring nullable

Some source sheets are created as assignments by a teacher to be completed by students. If this is one of those sheets this will be the URL path to their profile.

ownerProfileUrlstring nullable

The URL Path that will link to a user's profile on the Sefaria site.

ownerImageUrlstring nullable

Sheet owner image.

status'public' | 'unlisted'

a string indicating whether the sheet is public or unlisted

viewsinteger

Number of source sheet views.

summarystring nullable

A user generated description of the source sheet

attributionstring nullable

Some source sheets are made by copying another users. If so, an attribution field will be created and displayed here.

is_featuredboolean nullable

Previously a source sheet flagged with is_featured would be promoted throughout the site in various places. This behavior was removed in 2022 but some of the data remains.

categorystring nullable

This will always return Sheets

typestring nullable

Example response

[
  {
    "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"
  }
]