get family library

GET

/card/family/library

Get the content that a family has in their library

• The contextual family is the authorised user's family

• By default, expired and deleted content is excluded from the response (unless specified using the showexpired and showdeleted query string parameters)

Request

• Using the querys tring ?view=groups will include library groups and content a family has in the response under the groups object

  • For each group the cards property is returned as an empty array / not populated. This is to support clients deserialising the object.

• The subscriptions for the family are included in the response under the subscriptions property

  • subscriptions: [] signifies the family has no subscriptions

Response

• inFamilyLibrary - is true for all library items except for user generated content items (such as playlists) where it will be false. User generated content is returned as part of the library and cannot be removed from the library.

Deprecated Fields

• masterUid - represents the identifier for the card. This will be removed at a later date.

Authorizations

bearerAuth

TypeHTTP (bearer)

Parameters

Query Parameters

view

Include additional views of the family library.

'groups' - include the family library groups in the response

Typestring

Examplegroups

showprovenance

Typestring

Exampletrue

showexpired

Include content that has expired or the family no longer own

Typestring

Exampletrue

showdeleted

Include content that has been removed from the family library

Typestring

Exampletrue

coverWidth

The image width in pixels for 'card.metadata.cover' images. If unspecified it defaults to 250 pixels

Typestring

Example100

Responses

200 OK

Content-Type

application/json

{

"cards": [

{

"accessExpiresAt": "2024-06-28T23:59:59.999Z",

"accessExpiryReason": "free-access-expired",

"addedAt": "2024-05-29T11:56:14.555Z",

"card": {

"availability": "free",

"cardId": "37KwQ",

"content": {

"activity": "yoto_Player",

"availability": "",

"config": {

"onlineOnly": true

},

"cover": {

"imageL": "https://card-content.yotoplay.com/yoto/pub/bLwkrFs6iwUBYcLNU-Iglcvci2MxCIAly84EyI2Yky4"

},

"editSettings": {

"autoOverlayLabels": "chapters",

"editKeys": false

},

"playbackType": "linear",

"version": "1"

},

"createdAt": "2021-01-12T09:32:27.141Z",

"metadata": {

"author": "Greg",

"category": "radio",

"cover": {

"imageL": "https://card-content.yotoplay.com/yoto/pub/bLwkrFs6iwUBYcLNU-Iglcvci2MxCIAly84EyI2Yky4?width=250"

},

"description": "Radio Radio Radio",

"media": {

"duration": 0,

"fileSize": 0,

"hasStreams": true

},

"status": {

"name": "live",

"updatedAt": "2021-01-13T11:20:38.356Z"

}

},

"slug": "my-radio-card",

"sortkey": "my-radio-card",

"title": "My Radio Card",

"updatedAt": "2023-01-26T17:30:50.674Z",

"userId": "yoto"

},

"cardId": "37KwQ",

"createdAt": "2024-05-29T11:56:14.555Z",

"familyId": "65b120377258d846de4595d8",

"inFamilyLibrary": true,

"lastPlayedAt": "2024-05-29T11:56:14.555Z",

"masterUid": "_temp_37KwQ",

"provenanceId": "65dc78d8b7ec1dd3ea02a862",

"reason": "free-content-add",

"shareType": "yoto",

"updatedAt": "2024-05-29T11:56:14.555Z"

},

{

"addedAt": "2024-04-30T08:56:24.517Z",

"card": {

"availability": "premium",

"cardId": "5IiME",

"content": {

"activity": "yoto_Player",

"availability": "",

"config": {

"disableAutoOverlayLabels": false

},

"cover": {

},

"editSettings": {

"autoOverlayLabels": "disabled",

"editKeys": false

},

"playbackType": "linear",

"version": "1"

},

"createdAt": "2020-04-08T10:10:14.913Z",

"metadata": {

"author": "Naxos",

"category": "music",

"cover": {

},

"description": null,

"order": "500"

},

"slug": "naxos-adventures-in-music",

"sortkey": "naxos-adventures-in-music",

"title": "Adventures in Music",

"updatedAt": "2020-04-08T10:10:27.491Z",

"userId": "yoto"

},

"cardId": "5IiME",

"createdAt": "2024-04-30T08:56:24.517Z",

"familyId": "65b120377258d846de4595d8",

"inFamilyLibrary": true,

"lastPlayedAt": "2024-04-30T08:56:24.517Z",

"masterUid": "_temp_5IiME",

"provenanceId": "6630b2386e312b31728c4513",

"reason": "customer-support-add",

"shareType": "yoto",

"updatedAt": "2024-04-30T08:56:24.517Z"

},

{

"addedAt": "2024-04-29T14:04:06.501Z",

"card": {

"cardId": "feNkK",

"clubAvailability": [

],

"content": {

"activity": "yoto_Player",

"availability": "",

"config": {

"onlineOnly": true

},

"cover": {

"imageL": "https://yoto-card-api-test-media.s3.eu-west-2.amazonaws.com/1AK7O3RyIVFUe9PkWPIZ8Mj5-PNf4Q3KwpVlcAfb5keJ7QfYFr5OIFk6r3ULQswWb/pub/FX1ayk6T10VF8UCy-T_c9LdLXvhDWi5R0b7o8U_KXPI"

},

"editSettings": {

"contentType": "rss-podcast",

"podcastTrackDisplay": {

"icon16x16": "https://yoto-card-api-test-media.s3.eu-west-2.amazonaws.com/yoto/qIr2cG7h0qhRW0nbMV8X094e-b-Fo-v7_OOBWjLWkQM"

},

"podcastType": "rss-podcast",

"transcodeAudioUploads": true

},

"playbackType": "linear",

"version": "1"

},

"createdAt": "2022-08-03T11:04:55.973Z",

"lastCheckedAt": "2024-05-29T06:45:31.325Z",

"metadata": {

"author": "Molly Oldfield",

"category": "podcast",

"cover": {

"imageL": "https://yoto-card-api-test-media.s3.eu-west-2.amazonaws.com/1AK7O3RyIVFUe9PkWPIZ8Mj5-PNf4Q3KwpVlcAfb5keJ7QfYFr5OIFk6r3ULQswWb/pub/FX1ayk6T10VF8UCy-T_c9LdLXvhDWi5R0b7o8U_KXPI?width=250"

},

"description": "Children are full of curiosity and questions about the world. Each Friday, join Molly Oldfield, write of the weekly kids quiz in the Guardian each Saturday, the original QI elf and author and host of Everything Under The Sun (both the book and podcast) as she answers questions sent in by children around the world with the help of experts including Neil Gaiman, Heston Blumenthal, Grayson Perry, Lauren Child, Richard Branson and Sophie Dahl to the fish curators at the Natural History Museum. If you're a kid - big or small - with questions you want answered or if you want to learn interesting facts about life on earth, this is the award winning podcast for you. Do check out Everything Under The Sun - a curious question for every day of the year, published by Ladybird books now! See acast.com/privacy for privacy and opt-out information.",

"feedUrl": "https://feeds.acast.com/public/shows/3fd78ba5-05b8-47ba-9897-80a3b1732554",

"imageUrl": "https://assets.pippa.io/shows/611e9f5a06c05e4053f40b98/show-cover.jpg",

"lastBuildDate": null,

"media": {

"duration": 0,

"fileSize": 0

}

},

"title": "Everything Under The Sun",

"updatedAt": "2024-05-10T10:15:31.716Z",

"userId": "yoto"

},

"cardId": "feNkK",

"createdAt": "2024-04-29T14:04:06.501Z",

"familyId": "65b120377258d846de4595d8",

"inFamilyLibrary": true,

"lastPlayedAt": "2024-04-29T14:04:06.501Z",

"masterUid": "_temp_feNkK",

"provenanceId": "662fa8d66e312b31727a0e7c",

"reason": "customer-support-add",

"shareType": "yoto",

"updatedAt": "2024-04-29T14:04:06.501Z"

},

{

"addedAt": "2024-04-26T10:40:24.253Z",

"card": {

"cardId": "hFhkr",

"content": {

"activity": "yoto_Player",

"availability": "",

"config": {

"onlineOnly": true

},

"cover": {

"imageL": "https://yoto-card-api-test-media.s3.eu-west-2.amazonaws.com/1AK7O3RyIVFUe9PkWPIZ8Mj5-PNf4Q3KwpVlcAfb5keJ7QfYFr5OIFk6r3ULQswWb/pub/9aKc50Pg1_mW8grj_MCIUP9tQ7xzbqel8w6e7vCnO00"

},

"editSettings": {

"podcastTrackDisplay": {

"icon16x16": "https://yoto-card-api-test-media.s3.eu-west-2.amazonaws.com/yoto/qIr2cG7h0qhRW0nbMV8X094e-b-Fo-v7_OOBWjLWkQM"

},

"podcastType": "rss-podcast",

"transcodeAudioUploads": true

},

"playbackType": "linear",

"version": "1"

},

"createdAt": "2022-08-02T21:49:14.743Z",

"lastCheckedAt": "2024-05-29T06:45:30.754Z",

"metadata": {

"author": "National Geographic Kids",

"category": "podcast",

"cover": {

"imageL": "https://yoto-card-api-test-media.s3.eu-west-2.amazonaws.com/1AK7O3RyIVFUe9PkWPIZ8Mj5-PNf4Q3KwpVlcAfb5keJ7QfYFr5OIFk6r3ULQswWb/pub/9aKc50Pg1_mW8grj_MCIUP9tQ7xzbqel8w6e7vCnO00?width=250"

},

"description": "Oh, Muses! Hear our podcast and allow us to recall some of the greatest stories ever told. Stories of gods and goddesses, monsters, and heroes! Enjoy this kid-friendly retelling of classic ancient Greek myths for the whole family.",

"feedUrl": "https://feeds.megaphone.fm/ESP4751925729",

"imageUrl": "https://megaphone.imgix.net/podcasts/9c266f68-7e69-11ea-97e1-1bd3af9fcebe/image/1x1.jpg?ixlib=rails-2.1.2&max-w=3000&max-h=3000&fit=crop&auto=format,compress",

"lastBuildDate": null,

"media": {

"duration": 32452

}

},

"sortkey": "greeking",

"title": "Greeking Out from National Geographic Kids",

"updatedAt": "2024-05-24T09:01:49.945Z",

"userId": "yoto"

},

"cardId": "hFhkr",

"createdAt": "2024-04-26T10:40:24.253Z",

"familyId": "65b120377258d846de4595d8",

"inFamilyLibrary": true,

"lastPlayedAt": "2024-04-26T10:40:24.253Z",

"masterUid": "_temp_hFhkr",

"provenanceId": "662b84986e312b3172320786",

"reason": "customer-support-add",

"shareType": "yoto",

"updatedAt": "2024-04-26T10:40:24.253Z"

},

{

"addedAt": "2024-04-08T20:10:16.053Z",

"card": {

"availability": "free",

"cardId": "ezObR",

"content": {

"activity": "yoto_Player",

"availability": "",

"config": {

},

"cover": {

},

"playbackType": "linear",

"version": "1"

},

"createdAt": "2021-03-17T11:23:52.227Z",

"metadata": {

"category": "podcast",

"feedUrl": "https://podcasts.files.bbci.co.uk/p02pnn9d.rss",

"media": {

"duration": 8194

}

},

"slug": "test-card-slug-test-card.e2e-0.grxf78l6mw",

"sortkey": "test-card-slug-test-card.e2e-0.grxf78l6mw",

"updatedAt": "2021-03-17T11:23:52.227Z",

"userId": "yoto"

},

"cardId": "ezObR",

"createdAt": "2024-04-08T20:10:16.053Z",

"familyId": "65b120377258d846de4595d8",

"inFamilyLibrary": true,

"lastPlayedAt": "2024-04-08T20:10:16.053Z",

"provenanceId": "66144f282b0ae2110f076ecb",

"reason": "user-add",

"shareType": "yoto",

"updatedAt": "2024-04-08T20:10:16.053Z"

}

],

"groups": [

{

"createdAt": "2024-05-17T12:49:45.962Z",

"familyId": "65b120377258d846de4595d8",

"id": "-deaCzUCjMPWKcCDH06KT",

"imageId": "fp-cards",

"imageUrl": "https://cdn.yoto.io/library/groups/fp-cards.png",

"items": [

],

"lastModifiedAt": "2024-05-17T12:50:08.507Z",

"name": "No Longer My Favourites"

},

{

"createdAt": "2024-05-17T23:51:38.575Z",

"familyId": "65b120377258d846de4595d8",

"id": "02oHitesPWJq-VlP4oary",

"imageId": "fp-cards",

"imageUrl": "https://cdn.yoto.io/library/groups/fp-cards.png",

"items": [

{

"addedAt": "2024-05-17T23:51:38.575Z",

"contentId": "62bEO"

}

],

"lastModifiedAt": "2024-05-17T23:51:38.575Z",

"name": "My Favourites"

},

{

"createdAt": "2024-05-17T23:31:29.279Z",

"familyId": "65b120377258d846de4595d8",

"id": "6Jt8hSBvYBfZTNAgYh1RD",

"imageId": "fp-cards",

"imageUrl": "https://cdn.yoto.io/library/groups/fp-cards.png",

"items": [

{

"addedAt": "2024-05-17T23:31:29.279Z",

"contentId": "62bEO"

}

],

"lastModifiedAt": "2024-05-17T23:31:29.279Z",

"name": "My Favourites"

},

{

"created": "2024-02-28T10:38:04.134Z",

"familyId": "65b120377258d846de4595d8",

"id": "B5BOsnzn8VG-vUvHKatJA",

"imageId": "some-default-id",

"imageUrl": "https://cdn.yoto.io/library/groups/fp-cards.png",

"items": [

{

"contentId": "62bEO"

}

],

"lastModified": "2024-02-28T10:38:04.134Z",

"name": "My Favourites"

},

{

"createdAt": "2024-05-03T21:21:47.757Z",

"familyId": "65b120377258d846de4595d8",

"id": "CHwV5N2p2h-9Njdn-bQfI",

"imageId": "some-default-id",

"imageUrl": "https://cdn.yoto.io/library/groups/fp-cards.png",

"items": [

],

"lastModifiedAt": "2024-05-03T22:00:33.706Z",

"name": "No Longer My Favourites"

},

{

"createdAt": "2024-05-21T14:35:10.210Z",

"familyId": "65b120377258d846de4595d8",

"id": "D6MlAKc4HSqjYPn8EgVx2",

"imageId": "fp-cards",

"imageUrl": "https://cdn.yoto.io/library/groups/fp-cards.png",

"items": [

{

"addedAt": "2024-05-21T14:35:10.210Z",

"contentId": "62bEO"

}

],

"lastModifiedAt": "2024-05-21T14:35:10.210Z",

"name": "My Favourites"

},

{

"created": "2024-02-21T14:44:28.638Z",

"familyId": "65b120377258d846de4595d8",

"id": "Dg9IIszjhMki9HAq6x_0q",

"imageId": "some-default-id",

"imageUrl": "https://cdn.yoto.io/library/groups/fp-cards.png",

"items": [

{

"contentId": "62bEO"

}

],

"lastModified": "2024-02-21T14:44:28.638Z",

"name": "My Favourites"

},

{

"createdAt": "2024-05-03T22:01:21.814Z",

"familyId": "65b120377258d846de4595d8",

"id": "G7xU8h6oBiX1pjIyhCeir",

"imageId": "some-default-id",

"imageUrl": "https://cdn.yoto.io/library/groups/fp-cards.png",

"items": [

],

"lastModifiedAt": "2024-05-03T22:01:25.935Z",

"name": "No Longer My Favourites"

},

{

"created": "2024-02-21T16:29:38.015Z",

"familyId": "65b120377258d846de4595d8",

"id": "GWSKYsLLkLD0emX7zchhR",

"imageId": "some-default-id",

"imageUrl": "https://cdn.yoto.io/library/groups/fp-cards.png",

"items": [

{

"contentId": "62bEO"

}

],

"lastModified": "2024-02-21T16:29:38.015Z",

"name": "My Favourites"

},

{

"createdAt": "2024-05-17T23:15:43.594Z",

"familyId": "65b120377258d846de4595d8",

"id": "Qt1UJJag3SxmjiW3i3sxj",

"imageId": "fp-cards",

"imageUrl": "https://cdn.yoto.io/library/groups/fp-cards.png",

"items": [

{

"addedAt": "2024-05-17T23:15:43.594Z",

"contentId": "62bEO"

}

],

"lastModifiedAt": "2024-05-17T23:15:43.594Z",

"name": "My Favourites"

},

{

"createdAt": "2024-05-03T21:19:22.302Z",

"familyId": "65b120377258d846de4595d8",

"id": "TVXiNNwA7SR-JXG_whwTD",

"imageId": "some-default-id",

"imageUrl": "https://cdn.yoto.io/library/groups/fp-cards.png",

"items": [

{

"addedAt": "2024-05-03T21:19:22.302Z",

"contentId": "62bEO"

}

],

"lastModifiedAt": "2024-05-03T21:19:22.302Z",

"name": "My Favourites"

},

{

"createdAt": "2024-05-17T23:43:50.702Z",

"familyId": "65b120377258d846de4595d8",

"id": "WzvYxUC-DLMOeRvx_ibG1",

"imageId": "fp-cards",

"imageUrl": "https://cdn.yoto.io/library/groups/fp-cards.png",

"items": [

{

"addedAt": "2024-05-17T23:43:50.702Z",

"contentId": "62bEO"

}

],

"lastModifiedAt": "2024-05-17T23:43:50.702Z",

"name": "My Favourites"

},

{

"created": "2024-02-21T15:11:19.066Z",

"familyId": "65b120377258d846de4595d8",

"id": "b4mNb205liWv7PiHa0Gyi",

"imageId": "some-default-id",

"imageUrl": "https://cdn.yoto.io/library/groups/fp-cards.png",

"items": [

{

"contentId": "62bEO"

}

],

"lastModified": "2024-02-21T15:11:19.066Z",

"name": "My Favourites"

},

{

"created": "2024-02-23T08:27:03.498Z",

"familyId": "65b120377258d846de4595d8",

"id": "bKOMM19n4KcYD-EnhnSez",

"imageId": "some-default-id",

"imageUrl": "https://cdn.yoto.io/library/groups/fp-cards.png",

"items": [

],

"lastModified": "2024-02-23T08:30:00.562Z",

"name": "No Longer My Favourites"

},

{

"createdAt": "2024-05-17T23:25:00.755Z",

"familyId": "65b120377258d846de4595d8",

"id": "bRikm2SU5fZCNAf_omeEl",

"imageId": "fp-cards",

"imageUrl": "https://cdn.yoto.io/library/groups/fp-cards.png",

"items": [

{

"addedAt": "2024-05-17T23:15:43.594Z",

"contentId": "62bEO"

}

],

"lastModifiedAt": "2024-05-17T23:25:00.755Z",

"name": "My Favourites"

},

{

"createdAt": "2024-05-03T21:21:15.905Z",

"familyId": "65b120377258d846de4595d8",

"id": "lhe-pbrxQKGrsGBP2DHxm",

"imageId": "some-default-id",

"imageUrl": "https://cdn.yoto.io/library/groups/fp-cards.png",

"items": [

{

"addedAt": "2024-05-03T21:21:15.905Z",

"contentId": "62bEO"

}

],

"lastModifiedAt": "2024-05-03T21:21:15.905Z",

"name": "My Favourites"

},

{

"createdAt": "2024-05-17T23:25:24.379Z",

"familyId": "65b120377258d846de4595d8",

"id": "nd4dntd40ZYKya4FU_tbM",

"imageId": "fp-cards",

"imageUrl": "https://cdn.yoto.io/library/groups/fp-cards.png",

"items": [

{

"addedAt": "2024-05-17T23:15:43.594Z",

"contentId": "62bEO"

}

],

"lastModifiedAt": "2024-05-17T23:25:24.379Z",

"name": "My Favourites"

},

{

"createdAt": "2024-05-17T21:56:06.957Z",

"familyId": "65b120377258d846de4595d8",

"id": "rv3zlZHWHrP8HmQpKdBVQ",

"imageId": "fp-cards",

"imageUrl": "https://cdn.yoto.io/library/groups/fp-cards.png",

"items": [

{

"addedAt": "2024-05-17T21:56:06.957Z",

"contentId": "62bEO"

}

],

"lastModifiedAt": "2024-05-17T21:56:06.957Z",

"name": "My Favourites"

}

],

"subscriptions": [

{

"store": "dev",

"validUntil": "2099-01-02T00:00:00.000Z"

}

]

}

GET

/card/family/library

Playground

Authorization

bearerAuth

Variables

Key

Value

view

showprovenance

showexpired

showdeleted

coverWidth

Samples