Skip to main content

User-related API environment

Production user-related API docs

These pages describe the Production user-related API stack.

Use production OAuth credentials, production API base URLs, and production app URLs when following this documentation.

Need to test before going live? Switch to the Pre-live docs using the environment switcher above.

Get collection items by id​

Get all resources that belong to an existing collection by collection id. Use __default__ to fetch the virtual Favorites collection.

Path Parameters
    collectionId string

    Collection ID. Use __default__ for the virtual Favorites collection.

Query Parameters
    sortBy string

    Possible values: [recentlyAdded, verseKey]

    Sort the collection items either by the time they were added at descendingly or by Ayah key.

    last integer

    Possible values: >= 1 and <= 20

    The number of items to be fetched. Should be used together with before

    first object

    Possible values: >= 1 and <= 20

    The number of items to be fetched.

    after object

    The cursor after which you want to get the next page of items. Should be used together with first

    before object

    The cursor before which the previous page of items will be fetched. Should be used together with last

Responses

Request has been handled successfully.

Schema
    success boolean
    data object
    collection object
    id string required
    name string required
    slug string nullable required
    isPrivate boolean required
    isDefault boolean required
    updatedAt date-time nullable required
    url string nullable
    bookmarksCount integer
    resourcesCount integer
    count integer
    bookmarks object[]
  • Array [
    • id string required
    createdAt date-time required
    type string required
    key integer required
    verseNumber integer nullable
    group string required
    isInDefaultCollection boolean required
    isReading boolean nullable required
    collectionsCount integer required

    Total user-visible collection memberships for this bookmark, including Favorites when isInDefaultCollection=true.

  • ]
    • pagination object
    startCursor string
    endCursor string
    hasNextPage boolean
    hasPreviousPage boolean
Loading...