Skip to content
Tiny Visions API

Entities Data

Get an entity

Get data for an entity.

Get an entity by ID

/entities/7b397dd1-f627-467c-bdbc-f850a118e099

Entity response

{ "data": [ { "type": "entities", "id": "7b397dd1-f627-467c-bdbc-f850a118e099", "attributes": { "reference": "TV22181883", "name": "Beastwars", "slug": "beastwars", "url": "https://tinyvisions.nz/who/beastwars", "profile": "New Zealand sludge metal four-piece Beastwars abide by one steadfast maxim: Obey the Riff." }, "links": { "self": "https://tinyvisions.nz/entities/7b397dd1-f627-467c-bdbc-f850a118e099" } } ] }

Parameters

Additional data can be returned with an ?include= query appended to the resource request.

Credits

Collection of Videos data filtered by an entity’s credit(s).

Images

A collection of formats and sizes for profile and iconimages, representative of an entity.

Resources

A collection of links for 3rd-party information resources about an entity.

Tags

A collection of non-hierarchical terms classifying an entity.

Albums

Album data associated with an entity.

Query a single parameter

?include=credits

Query multiple parameters

?include=credits,images,tags

Credits

Get credits data associated with an entity.

Get credits

?include=credits

Credits response

{ "included": [ { "type": "credits", "id": "15bc0b92-19a1-406b-ab07-e5fd4e1dbb52", "attributes": { "creditType": "director", "creditNotes": null, "isPrimary": 1, "video": { "id": "0fe250c3-a080-4bbc-8c05-e3d3f023d756", "reference": "TV35091663", "songTitle": "Dune", "songSlug": "dune", "url": "https://tinyvisions.nz/video/beastwars/dune", "synopsis": null, "yearReleased": 2013, "duration": 186, "aspectRatio": "4:3", "nzOnAirFunded": 1, "versionCount": 1, "versionName": null, "versionNumber": 1, "artists": [ { "id": "7b397dd1-f627-467c-bdbc-f850a118e099", "name": "Beastwars", "slug": "beastwars", "url": "https://tinyvisions.nz/who/beastwars", "profile": "New Zealand sludge metal four-piece Beastwars abide by one steadfast maxim: Obey the Riff.", "is_primary": 1 } ] } } } ] }

Images

Get images data associated with an entity.

Content

profile is a representative image of an entity. icon can contain the same or alternate visual content and is intended for smaller display sizes.

Aspect ratio

profile may be any shape, while icon is always square.

Get images

?include=images

Images response

{ "included": [ { "type": "images", "id": "c1e5b4ec-d0fd-4930-848b-ea0ccceda86f", "attributes": { "profile": { "jpg": { "small": "https://tinyvisions.nz/images/ep-simon-ward-246813579-s.jpg", "medium": "https://tinyvisions.nz/images/ep-simon-ward-246813579-m.jpg", "large": "https://tinyvisions.nz/images/ep-simon-ward-246813579-l.jpg", "raw": "https://tinyvisions.nz/images/ep-simon-ward-246813579-r.jpg" }, "webp": { "small": "https://tinyvisions.nz/images/ep-simon-ward-246813579-s.webp", "medium": "https://tinyvisions.nz/images/ep-simon-ward-246813579-m.webp", "large": "https://tinyvisions.nz/images/ep-simon-ward-246813579-l.webp", "raw": "https://tinyvisions.nz/images/ep-simon-ward-246813579-r.webp" } }, "icon": { "jpg": { "small": "https://tinyvisions.nz/images/ei-simon-ward-246813579-s.jpg", "medium": "https://tinyvisions.nz/images/ei-simon-ward-246813579-m.jpg", "large": "https://tinyvisions.nz/images/ei-simon-ward-246813579-l.jpg", "raw": "https://tinyvisions.nz/images/ei-simon-ward-246813579-r.jpg" }, "webp": { "small": "https://tinyvisions.nz/images/ei-simon-ward-246813579-s.webp", "medium": "https://tinyvisions.nz/images/ei-simon-ward-246813579-m.webp", "large": "https://tinyvisions.nz/images/ei-simon-ward-246813579-l.webp", "raw": "https://tinyvisions.nz/images/ei-simon-ward-246813579-r.webp" } } } } ] }

Resources

Get resources data associated with an entity.

Get resources

?include=resources

Resources response

{ "included": [ { "type": "resources", "id": "b963bfeb-982e-4892-804d-63a3a4f3c8a0", "attributes": [ { "name": "AudioCulture", "url": "https://www.audioculture.co.nz/people/beastwars" }, { "name": "NZ On Screen", "url": null }, { "name": "Ngā Taonga Sound & Vision", "url": null }, { "name": "Discogs", "url": "https://www.discogs.com/artist/2384316-Beastwars" } ] } ] }

Tags

Get tags data associated with an entity.

Get tags

?include=tags

Tags response

{ "included": [ { "type": "tags", "id": "cfb983d9-df38-4e5d-8ff7-61fb08433548", "attributes": { "tagName": "", "tagSlug": "", "tagType": "", "tagDescription": "" } } ] }

Albums

Get albums data associated with an entity.

Get an album

?include=albums

Album response

{ "included": [ { "type": "albums", "id": "ed2815eb-ac01-41b5-a61d-046adb7fbc6b", "attributes": { "albumName": "Blood Becomes Fire", "albumSlug": "blood-becomes-fire", "albumNotes": null } } ] }

Album image

Get the cover image associated with an album.

Get an album cover

?include=albums.images