Sign in

v1

latestOpenAPI 3.0.2GNU AGPLv32026-07-245983524.8 KB
Sheets

Returns a full Sheet if it has been modified since the given timestamp. If it the Sheet has not been modified, returns an empty/unchanged response. This endpoint is useful for clients that cache Sheets.

get/api/sheets/modified/{sheet_id}/{timestamp}

Path parameters

sheet_idinteger required

Numeric sheet ID. Find it in the sheet URL: https://www.sefaria.org/sheets/{sheet_id}.

timestampstring required

An ISO-8601 timestamp. The sheet is returned only if its dateModified is more recent than this value.

Response

Successful Response

idinteger

Numeric id of the sheet — the same value that appears in the sheet's URL on voices.sefaria.org.

titlestring

Title of the source sheet.

summarystring

A short, plain-text description of the sheet's contents.

ownerinteger

Numeric Sefaria user ID of the sheet's owner.

ownerNamestring

Display name of the sheet's owner.

ownerProfileUrlstring

Path to the owner's public profile on Sefaria.

ownerImageUrlstring

URL of the owner's profile image.

status'public' | 'unlisted'

Visibility of the sheet — public for sheets that are publicly listed, unlisted for sheets accessible by direct link only.

sheetLanguagestring

Default display language for the sheet.

dateCreatedstring

Timestamp the sheet was first created. May be ISO-8601 or a Unix timestamp string depending on the sheet's age.

dateModifiedstring

Timestamp of the most recent modification to the sheet.

datePublishedstring

Timestamp the sheet was first made public. Empty if the sheet has never been published.

viewsinteger

Number of times the sheet has been viewed.

likesinteger[]

Array of user IDs who have liked the sheet.

optionsobject

Sheet-level display options used by the Sefaria source sheet editor.

tagsstring[]

Free-text tags applied to the sheet. Often empty in favor of topics.

displayedCollectionstring

Slug of the collection currently displayed alongside this sheet, if any.

collectionNamestring

Display name of the collection in displayedCollection, if set.

collectionImagestring

URL of the collection's image, if set.

includedRefsRef[]

All Sefaria refs cited anywhere on the sheet.

expandedRefsRef[]

Each entry in includedRefs expanded out to its constituent segment refs.

nextNodeinteger

The next available node ID — used by the editor when appending a new source.

sheetNoticestring nullable

Optional moderator notice attached to the sheet. null when no notice is set.

Example response

{
  "includedRefs": [
    "Mishnah Peah 4:2"
  ],
  "expandedRefs": [
    "Mishnah Peah 4:2"
  ],
  "sources": [
    {
      "ref": "Mishnah Peah 4:2"
    }
  ]
}