Opencollection

Version: 2

The new opencollection api

Default response content-types: application/json
Schemes: https

Summary

Tag: Archive

Operation Description
GET /archive/collection/

Return the list of archive collections

GET /archive/set/

Return the list of archive sets

GET /archive/image/

Return a list of archive images

Tag: Artist

Operation Description
GET /artist/

Returns a set of artist items matching the given criteria.

GET /artist/{artist_id}

Get information on an artist

Tag: GeographicalLocation

Operation Description
GET /geographical-location/

Return a list of geographical locations that may be associated objects in the Museum

GET /geographical-location/{geographical_location_id}

Get information on a geographical location object

Tag: Collection

Operation Description
GET /collection/

Return the list of collections at the museum

GET /collection/{collection_id}

Get details about a specific collection

GET /collection/{collection_id}/highlight

Get highlighted objects of a collection

GET /collection/{collection_id}/object

Get objects of a collection

Tag: Object

Operation Description
GET /collection/{collection_id}/highlight

Get highlighted objects of a collection

GET /collection/{collection_id}/object

Get objects of a collection

GET /object/

Return a list of objects at the museum. For information on what the available fields are, you can reference objects in the collection.

GET /object/{object_id}

Get information on an object

GET /object/{object_id}/image

Get data about an object's images

GET /object/{object_id}/related

Get other objects related to the specified object

Tag: Exhibition

Operation Description
GET /exhibition/

Returns a set of exhibition items matching the given criteria and a total count of exhibitions that match the query.

GET /exhibition/{exhibition_id}

Get details about an exhibition, including associated collections, images, tags, and didactics

Tag: Location

Operation Description
GET /museum-location/

Returns a set of locations items matching the given criteria.

GET /museum-location/{location_id}

Get information on a museum location

GET /museum-location/{location_id}/objects

Get

Tag: Research

Operation Description
GET /research/pna1923/

Get research abstracts from the African Art Exhibition of 1923

Tag: Tag

Operation Description
GET /tag/

Get all tags or a subset of tags based on given filters

Tag: Luce

Operation Description
GET /luce/object/

Return a list of luce objects that meet the specified parameters

GET /luce/object/{object_id}

Get information on a luce object

GET /luce/case/

Return a list of luce cases that meet the specified parameters

GET /luce/case/{case_id}

Get information on a single luce case selected via its id

GET /luce/case/{case_id}/objects/

Return a list of luce objects that reside in a luce case

GET /luce/theme/

Return a list of themes associated with the Luce Collection

GET /luce/theme/{theme_id}

Get information on a luce theme

GET /luce/theme/objects/

Return a list of luce objects associated with a luce theme

GET /luce/artist/

Return a list of objects containing artist information about artists who have pieces within the Luce Center for American Art

Paths

Return the list of archive collections

GET /archive/collection/

Tags: Archive

Archive collections are different from regular collections

Uses default content-types: application/json

200 OK

An array of archive collections

Return a list of archive images

GET /archive/image/

Tags: Archive

Use parameters to retrieve a specific subset OR a total count that matches the query if the total_count_only parameter is supplied and set to 1

limit

An integer indicating how many results to return

query integer (int64) , { x ∈ ℤ | x ≤ 35 }
offset

An integer indicating at which index of the full result set to begin at

query integer (int64)
type

Filter by type of set. Valid values are either 'library' or 'archives'

query string
archives_collection_id

Filter by images associated with the given archive collection id

query integer (int64)
archives_set_id

Filter by images associated with the given archive set id

query integer (int64)
country

Filter by images that are from the given country

query string
date

Filter by images that are from the given date

query string
tag

Filter by tag.

query string
caption

Filter by caption

query string
credit

Filter by credit

query string
title

Filter by title of related archive set

query string
rights_type_permissive

Filter by images that have a permissive copyright status

query boolean
keyword

Filter by keyword. This is a full text search of the archive image fields.

query string
total_count_only

Accepted values are 0 for false or 1 for true. If true, the total row count for the query will be returned instead of the normal results.

query integer (int64)

Uses default content-types: application/json

200 OK

An array of archive images OR a total count that matches the query if the total_count_only parameter is supplied and set to 1

Return the list of archive sets

GET /archive/set/

Tags: Archive

Archive sets are a little different from archive collections

archives_collection_id

If set, only sets associated with the given archive collection id will be returned.

query integer (int64)
type

Filter by type of set. Valid values are either 'library' or 'archives'

query string
is_primary_set

Limits results to only sets that are primary sets

query boolean
is_featured_set

Limits results to only sets that are 'featured'

query boolean

Uses default content-types: application/json

200 OK

An array of archive sets

Returns a set of artist items matching the given criteria.

GET /artist/

Tags: Artist

Returns id, name, nationality, and primary image for each artist OR a total count that matches the query if the total_count_only parameter is supplied and set to 1

limit

An integer indicating how many results to return

query integer (int64) , { x ∈ ℤ | x ≤ 35 }
offset

An integer indicating at which index of the full result set to begin at

query integer (int64)
name

Limits results to those where the artist name matches this string.

query string
nationality

Limits results to those where the artist nationality matches this string.

query string
keyword

Filter by keyword. This is a full text search of the artist fields.

query string
total_count_only

Accepted values are 0 for false or 1 for true. If true, the total row count for the query will be returned instead of artists.

query integer (int64)

Uses default content-types: application/json

200 OK

An array of artists OR a total count that matches the query if the total_count_only parameter is supplied and set to 1

Get information on an artist

GET /artist/{artist_id}

Tags: Artist

Nothing special to note

artist_id

ID of the artist to be fetched

path integer (int64)

Uses default content-types: application/json

200 OK

An artist

default

Unexpected error

Return the list of collections at the museum

GET /collection/

Tags: Collection

Returns id, name, and folder which is also the collection path

Uses default content-types: application/json

200 OK

An array of collections

Get details about a specific collection

GET /collection/{collection_id}

Tags: Collection

Nothing special to note

collection_id

ID of the collection to be fetched

path integer (int64)

Uses default content-types: application/json

200 OK

An exhibition

Get highlighted objects of a collection

GET /collection/{collection_id}/highlight

Tags: Collection, Object

Nothing special to note

collection_id

ID of the collection whose highlights to fetch

path integer (int64)

Uses default content-types: application/json

200 OK

Highlighted objects in the collection

Get objects of a collection

GET /collection/{collection_id}/object

Tags: Collection, Object

Nothing special to note

collection_id

ID of the collection whose objects to fetch

path integer (int64)
limit

An integer indicating how many results to return

query integer (int64) , { x ∈ ℤ | x ≤ 35 }
offset

An integer indicating at which index of the full result set to begin at

query integer (int64)

Uses default content-types: application/json

200 OK

Objects in the collection

Returns a set of exhibition items matching the given criteria and a total count of exhibitions that match the query.

GET /exhibition/

Tags: Exhibition

Returns id, title, primary_image, primary_image_id, start_date, end_date, organizing_department, location for each exhibition, location id OR a total count that matches the query if the total_count_only parameter is supplied and set to 1

limit

An integer indicating how many results to return

query integer (int64) , { x ∈ ℤ | x ≤ 35 }
offset

An integer indicating at which index of the full result set to begin at

query integer (int64)
decade

If used, limits results to exhibitions that started within that decade

query integer (int64)
hasImages

If true is passed in, limits results to those where exhibitions have a primary_image

query boolean
tag

Filter by tag

query string
title

Filter by title

query string
organizing_department

Filter by Organizing Department

query string
start_year

Filter by starting year of exhibition

query integer
end_year

Filter by ending year of exhibition

query integer
require_press_release

If true, only exhibitions that have press releases will be returned.

query boolean
require_didactic

If true, only exhibitions with didactics will be returned.

query boolean
keyword

Filter by keyword. This is a full text search of the exhibition fields.

query string
total_count_only

Accepted values are 0 for false or 1 for true. If true, the total row count for the query will be returned instead of exhibitions.

query integer (int64)

Uses default content-types: application/json

200 OK

an array of objects with a total count of exhibitons fetched OR a total count that matches the query if the total_count_only parameter is supplied and set to 1

Get details about an exhibition, including associated collections, images, tags, and didactics

GET /exhibition/{exhibition_id}

Tags: Exhibition

Nothing special to note

exhibition_id

ID of the exhibition to be fetched

path integer (int64)

Uses default content-types: application/json

200 OK

An exhibition

default

Unexpected error

Return a list of geographical locations that may be associated objects in the Museum

GET /geographical-location/

Tags: GeographicalLocation

Objects can be tied to a geographical location via possible origin, manufacture, etc. This method returns information about those locations.

limit

An integer indicating how many results to return

query integer (int64) , { x ∈ ℤ | x ≤ 35 }
offset

An integer indicating at which index of the full result set to begin at

query integer (int64)

Uses default content-types: application/json

200 OK

An array of geographical location objects

Get information on a geographical location object

GET /geographical-location/{geographical_location_id}

Tags: GeographicalLocation

Objects can be tied to a geographical location via possible origin, manufacture, etc. This method returns information about a location queried by id.

geographical_location_id

ID of the geographical location object to be fetched

path integer (int64)

Uses default content-types: application/json

200 OK

A geographical location object

default

Unexpected error

Return a list of objects containing artist information about artists who have pieces within the Luce Center for American Art

GET /luce/artist/

Tags: Luce

Artist is a catch-all term. Each artist object contains a role which may be 'artist,' 'maker,' 'designer,' etc.

limit

An integer indicating how many results to return

query integer (int64) , { x ∈ ℤ | x ≤ 35 }
offset

An integer indicating at which index of the full result set to begin at

query integer (int64)
search_by

Filter the results by the start of the name

query string

Uses default content-types: application/json

200 OK

An array of luce artist objects

Return a list of luce cases that meet the specified parameters

GET /luce/case/

Tags: Luce

The Luce Visible Storage Room houses Luce Objects in Cases. This method returns information about those Cases

limit

An integer indicating how many results to return

query integer (int64) , { x ∈ ℤ | x ≤ 35 }
offset

An integer indicating at which index of the full result set to begin at

query integer (int64)

Uses default content-types: application/json

200 OK

An array of objects

Get information on a single luce case selected via its id

GET /luce/case/{case_id}

Tags: Luce

The Luce Visible Storage Room houses Luce Objects in Cases. This method returns information about a specific case

case_id

ID of the luce case to be fetched

path integer (int64)

Uses default content-types: application/json

200 OK

A luce case

default

Unexpected error

Return a list of luce objects that reside in a luce case

GET /luce/case/{case_id}/objects/

Tags: Luce

Luce Cases in the Luce Visible Storage Room hold luce objects.

case_id

ID of the luce case for which associated objects should be fetched

path integer (int64)
limit

An integer indicating how many results to return

query integer (int64) , { x ∈ ℤ | x ≤ 35 }
offset

An integer indicating at which index of the full result set to begin at

query integer (int64)

Uses default content-types: application/json

200 OK

An array of objects

Return a list of luce objects that meet the specified parameters

GET /luce/object/

Tags: Luce

A Luce Object contains information about a museum object that is tailored to its association with the Luce Center for American Art

limit

An integer indicating how many results to return

query integer (int64) , { x ∈ ℤ | x ≤ 35 }
offset

An integer indicating at which index of the full result set to begin at

query integer (int64)
accession_number

A string representing the accession number of the object

query string
location_id

Filter by location associated with the Luce Center

query integer (int64)
theme_id

Filter by Luce theme

query integer (int64)
keyword

Filter by keyword

query string

Uses default content-types: application/json

200 OK

An array of luce objects

Get information on a luce object

GET /luce/object/{object_id}

Tags: Luce

A Luce Object contains information about a museum object that is tailored to its association with the Luce Center for American Art

object_id

ID of the luce object to be fetched

path integer (int64)

Uses default content-types: application/json

200 OK

A luce object

default

Unexpected error

Return a list of themes associated with the Luce Collection

GET /luce/theme/

Tags: Luce

This method returns the set of theme objects matching the given criteria.

limit

An integer indicating how many results to return

query integer (int64) , { x ∈ ℤ | x ≤ 35 }
offset

An integer indicating at which index of the full result set to begin at

query integer (int64)

Uses default content-types: application/json

200 OK

An array of luce theme objects

Return a list of luce objects associated with a luce theme

GET /luce/theme/objects/

Tags: Luce

This method returns the set of luce objects associated with a luce theme or its sub-theme

theme_id

ID of the luce theme for which associated objects should be fetched

path integer (int64)

Uses default content-types: application/json

200 OK

Collections of objects tied to either the main theme of a sub-theme of the theme

Get information on a luce theme

GET /luce/theme/{theme_id}

Tags: Luce

Luce Objects can be associated with specific luce themes and their sub-themes

theme_id

ID of the luce theme to be fetched

path integer (int64)

Uses default content-types: application/json

200 OK

A luce theme

default

Unexpected error

Returns a set of locations items matching the given criteria.

GET /museum-location/

Tags: Location

Returns location info and a sample of objects if a floor is specified

limit

An integer indicating how many results to return

query integer (int64) , { x ∈ ℤ | x ≤ 35 }
offset

An integer indicating at which index of the full result set to begin at

query integer (int64)
floor

Limits the results to a floor.

query integer (int64)
type

Limits results to a location type. room and area are valid.

query string

Uses default content-types: application/json

200 OK

An array of locations

Get information on a museum location

GET /museum-location/{location_id}

Tags: Location

Nothing special to note

location_id

ID of the location to be fetched

path integer (int64)

Uses default content-types: application/json

200 OK

A Location

default

Unexpected error

Get

GET /museum-location/{location_id}/objects

Tags: Location

Nothing special to note

location_id

ID of the location to be fetched

path integer (int64)
limit

An integer indicating how many results to return

query integer (int64)
offset

An integer indicating at which index of the full result set to begin at

query integer (int64)

Uses default content-types: application/json

200 OK

Object Information

default

Unexpected error

Return a list of objects at the museum. For information on what the available fields are, you can reference objects in the collection.

GET /object/

Tags: Object

This method returns the set of objects matching the given criteria.

limit

An integer indicating how many results to return

query integer (int64) , { x ∈ ℤ | x ≤ 35 }
offset

An integer indicating at which index of the full result set to begin at

query integer (int64)
keyword

Filter by keyword. This is a full text search of the primary object fields. By default results will be sorted by relevance. If using this parameter, all other parameters are ignored except limit, offset, and sort_by.

query string
tag

Filter by tag.

query string
accession_number

Return objects with this accession number. Only returns exact matches.

query string
object_year_begin

Limit results to objects with dates after this year.

query string
object_year_end

Limit results to objects with dates before this year.

query string
title

Filter by title.

query string
portfolio

Filter by portfolio.

query string
description

Filter by description.

query string
medium

Filter by medium.

query string
dynasty

Filter by dynasty.

query string
exhibition_id

Filter by exhibition_id.

query string
location_id

Filter by location_id.

query integer (int64)
geographical_location_id

Filter by id of geographical location.

query integer (int64)
highlight

Limits the search to highlighted objects. Accepted values are 0 for false or 1 for true.

query integer (int64)
collection_id

Limits the search to a collection.

query integer (int64)
artist_id

Limits the search to a specific artist

query integer (int64)
total_count_only

Accepted values are 0 for false or 1 for true. If true, the total row count for the query will be returned instead of the objects.

query integer (int64)
has_images

Accepted values are 0 for false or 1 for true. If true, only objects with images will be returned.

query integer (int64)
on_view_only

Accepted values are 0 for false or 1 for true. If true, only objects that are on view will be returned.

query integer (int64)
rights_type_permissive

Accepted values are 0 for false or 1 for true. If true, only objects with 'Creative Commons 3D' and 'no known copyright restrictions' will be returned.

query integer (int64)
rights_type_unclear

Accepted values are 0 for false or 1 for true. If true, only objects with rights type 'status unclear, research required' will be returned.

query integer (int64)
rights_type_orphaned

Accepted values are 0 for false or 1 for true. If true, only objects with rights type 'orphaned work' will be returned.

query integer (int64)
sort_by

If using the keyword parameter, can also sort results by either 'completeness' or 'relevance' using this parameter.

query string

Uses default content-types: application/json

200 OK

An array of objects OR a total count that matches the query if the total_count_only parameter is supplied and set to 1

Get information on an object

GET /object/{object_id}

Tags: Object

Nothing special to note

object_id

ID of the opencollection object to be fetched

path integer (int64)

Uses default content-types: application/json

200 OK

An opencollection object

default

Unexpected error

Get data about an object's images

GET /object/{object_id}/image

Tags: Object

Nothing special to note

object_id

ID of the opencollection object whose images you want to fetch

path integer (int64)

Uses default content-types: application/json

200 OK

An array of image objects

default

Unexpected error

Get research abstracts from the African Art Exhibition of 1923

GET /research/pna1923/

Tags: Research

Nothing special to note

limit

An integer indicating how many results to return

query integer (int64) , { x ∈ ℤ | x ≤ 35 }
offset

An integer indicating at which index of the full result set to begin at

query integer (int64)
page_no

Search abstracts with the given page number

query integer (int64)
keyword

keyword to search for in the abstracts

query string
name

search abstracts that have the given name in company names, last names, first names, etc. where applicable.

query string
web_theme

Search abstracts that are of the given theme. Valid values are 'correspondence', 'other textual material', 'publication', 'visual image', and 'catalog'

query string , x ∈ { correspondence , other textual material , publication , visual image , catalog }
doc_type

Search abstracts that are of the given document type. Valid values are 'Letter', 'Letter and attachment', 'Memo', 'Business card', 'List', 'Clipping', 'Receipt', 'Invitation', 'Letter, legal size', 'Membership card', 'photograph', 'Clipping, Legal Size', 'Telegram', 'List, oversize', 'Program', 'Clipping and Attachment', 'Post card', 'Text', 'Expedition Report', 'Exhibition Catalog', and 'Catalogue Cover'

query string , x ∈ { Letter , Letter and attachment , Memo , Business card , List , Clipping , Receipt , Invitation , Letter, legal size , Membership card , photograph , Clipping, Legal Size , Telegram , List, oversize , Program , Clipping and Attachment , Post card , Text , Expedition Report , Exhibition Catalog , Catalogue Cover }
start_year

If specified, only abstracts later than the given year will be retrieved.

query string
end_year

If specified, only abstracts earlier than the given year will be retrieved.

query string
sort_by

Sort the results by this value. Valid values are 'date_ascending', 'date_descending', 'name_ascending', 'name_descending', and 'document_type'.

query string , x ∈ { date_ascending , date_descending , name_ascending , name_descending , document_type }

Uses default content-types: application/json

200 OK

An array of abstracts

default

Unexpected error

Get all tags or a subset of tags based on given filters

GET /tag/

Tags: Tag

Tags are keywords that are related to an item. An item being an 'object', 'exhibition', 'artist', or 'archives_image'

limit

An integer indicating how many results to return

query integer (int64) , { x ∈ ℤ | x ≤ 35 }
offset

An integer indicating at which index of the full result set to begin at

query integer (int64)
item_id

ID of the item whose tags you want to fetch

query integer
item_type

The type of the items whose tags you want to fetch. Valid values are 'object', 'exhibition', 'artist', or 'archives_image'

query string

Uses default content-types: application/json

200 OK

An array of tags

Tag
default

Unexpected error

Schema definitions

ArchiveCollection: object

An object with information about a Libraries and Archive collection

id: integer

The id of the archive collection

title: string

The title of the collection

folder: string

The name of the collection string used in the website url

citation: string

The citation of the collection

image_count: integer

How many images this collection has

highlight_images: object[]

An array of archive images that highlight this archive collection

copy_summary: string

A summary of the archive collection

copy_content: string

A detailed description and history of the collection

notable_years: object[]

An array of years the collection has images from

notable_decades: object[]

An array of decades the collection has images from

geographical_locations: object[]

An array of geographical locations related to the archive collection

ArchiveImage: object

An object with information about a Libraries and Archive image

id: integer

The id of the image

archives_set_id: string

The id of the Libraries and Archive set the image is related to if any

filename: string

The filename of the image

caption: string

The caption of the image

short_caption: string

An abbreviated version of the caption

credit: string

The credit of the image

date: string (date)

Date of the image

notes: string

Other notes regarding the image

page: string

page

is_color: integer

Whether the image is color or not. 1 means color, 0 means no color.

file_source: string

Similar to imaging_project_name

image_source_size: string

The dimensions of the image

imaging_project_name: string

The name of the project that digitized the image

date_added: string (date)

The date the image was added

copyright_restricted: integer

1 means it is copyright restricted. 0 means it is not.

copy: string

copy text if any

rights_statement: string

copyright statement

citation: string

citation

archives_collection_name: string

The name of the archive collection the image is associated with if any

archives_collection_folder: string

The folder name of the archive collection associated with the image if any

archives_collection_id: integer

The id of the archive collection associated with the image if any

largest_derivative_url: string

The url to the largest version of the image

standard_size_url: string

The url to the standard size version of the image

geographical_locations: object[]

An array of countries that the image is from

ArchiveSet: object

An object with information about a Libraries and Archive set

id: integer

The id of the archive set

archives_collection_id: integer

The id of the archive collection this set is associated to if any

title: string

The title of the archive set

folder: string

The name of the string used in the website url

citation: string

The citation of the collection

author: string

The name of the author of the archive set

description: string

Short description of the set

imprint: string

imprint

series: string

series

date_display: string

date display

call_number: string

call number

copyright_status: string

Current copyright status

copyright_statement: string

copyright statement

copy: string

Long description of the set

image_count: integer

How many images this set has

highlight_images: object[]

An array of archive images that highlight this archive set

Artist: object

An object with information about an artist

id: integer

The id of the exhibition

name: string

Name of the artist

nationality: string

The nationality of the artist

start_year: string

The year the artist was born. NULL if unknown

end_year: string

The year the artist died. NULL if unknown

dates: string

The dates of the artist as well as the nationality

date_added: string

The date the artist was added to the database

primary_image: string

The filename of the primary image for this artist

role: string

The role of the artist in relation to an object (if data is returned as sub data of an object)

Collection: object

An object with information about a museum collection

id: integer

The id of the collection

name: string

The name of the collection

folder: string

The name of the collection string used in the website url

rank: integer

The ranking of the collection in relation to an object. Lower numbers mean higher rank

Completeness: object

An object containing information about completeness

name: string

The name of the completeness level

description: string

Description of the completeness level

percentage: integer

The completeness rating (0-100)

Error: object

code: integer (int32)
message: string
fields: string

Exhibition: object

An object with information about an exhibition

id: integer

The id of the exhibition

collections: array

array of collections associated with the exhibitions

images: array

array of the exhibition's images

labels: array

array of didactics associated with the exhibitions

title: string

The title of the exhibition

primary_image: string

The filename of the exhibtion's primary image

primary_image_id: integer

The id of the signature image

start_date: date

the exhibition's start date

end_date: date

the exhibition's end date

organizing_department: strings

the exhibition's organizing department

location: string

the exhibition's location

location_id: integer

The id of the exhibition's location

related_link: string

Brooklyn Museum web page associated with the exhibition (deprecated)

status: string

the status of the exhibition (deprecated)

tags: array

array of tags associated with the exhibition

ExhibitionQuery: object

An object containing either an array of objects with information about exhibitions or a number indicating the total count

total_count: integer (int64)

A count of total maximum exhibitions that can be returned from a given object query

exhibitions: object[]

An array of exhibitions that meet the query parameters from a given query

FullMuseumLocation: object

An object with information about a location in the museum

id: integer

The id of the location

type: string

The location type. Valid entries are area or room

name: string

The name of the location

description: string

Description of the location

public: boolean

If the location is public or not

floor: integer

Limits results to this floor

TMS_locationid: integer

TMS Location id

x_coord: integer

Museum x coordinate

y_coord: integer

Museum y coordinate

z_coord: integer

Museum z coordinate. This matches the floor.

parent_location_id: integer

ID of the location that this is a child of.

intranet_location_id: integer

ID of the intranet location

friendly_name: string

Name of Location to display

children: integer[]

collection of location ids for locations that have this location set as their parent

integer (int64)
objects: object[]

An array of the objects at this location.

object-count: integer

The count of objects at this location.

GeographicalLocation: object

An object containing information about a geographical location

id: integer

The id of the geographical location

name: string

The name of the location in (city, country) format

locale: string

The locale

city: string

The city

region: string

region

sub_region: string

sub region

state: string

state

country: string

country

continent: string

continent

sub_continent: string

sub continent

latitude: string

latitude

longitude: string

longitude

type: string

Will give more context on the relationship between the geographical location and the object

Image: object

An object with information about an image

filename: string

The filename of the image. To get the complete url of the image use the open collection CDN url format i.e. http://cdn2.brooklynmuseum.org/images/opencollection/objects/size{NUMBER}/{FILENAME}. NUMBER corresponds with the size of the image to be returned between 0 and 4, greater number is used for a larger image. FILENAME is the image filename.

id: integer

The id of the image

standard_size_url: string

The cdn url of the image (standard size which is size 2 for non-copyrighted works. size _fairuse for copyrighted works)

thumbnail_url: string

The cdn url of the thumbnail size image

derivatives: object[]

An array of available derivatives

largest_derivative_url: integer

The url of the largest sized derivative available for this image.

caption: string

The caption of the image

status: string

The value is either "active" or "disabled"

date: string (date)

Date of the image

credit: string

The credit of the image

view: string

The type of view of the image (e.g. front, back, overall, etc.)

date_added: string (date)

The date the image was added

load_date: string (date)

The date the image was loaded

rank: string

The rank of the image

is_color: integer

Whether the image is color or not. 1 means color, 0 means no color.

copyright_restricted: integer

1 means it is copyright restricted. 0 means it is not.

ImageDerivative: object

An object with information about an image derivative

size: integer

The size of the derivative. Will be an integer between 0 and 4

width: integer

Width in integer

height: integer

height in integer

Label: object

An object containing information about a label

id: integer

ID of the label

title: string

?? Probably don't use

content: string

The important label text

summary: string

Probably not used

LocationObjects: object

An object with information about locations (cities, countries, etc.) that the object is associated with

id: integer

The id of the location.

title: string

Title of the object.

accession_number: string

The object's accession number.

primary_image: string

The highest ranked (highest quality) image available for this object.

museum_location_id: integer

The ID of the museum location where the object is located.

collection_id: integer

ID of the collection that the object is in.

floor: integer

The floor the object is currently on.

parent_location_id: integer

The ID of the parent location where the museum is located.

parent_location_description: string

Description of the parent location where the museum is located.

LuceArtist: object

An object with information about an 'Artist' associated with at least one Luce Object

id: integer

The id of the luce object

role: string

The role of the artist can have

name: string

The name of the artist

sorted_name: string

the name setup for alphabetized sorting

LuceArtistRoleInfo: object

An object with information about an artist and their role with regard to a luce object

id: integer

The luce id of the artist

role: string

The role of the artist with regard to a luce object

name: string

The name of the artist

LuceCase: object

An object with information about a specific case in the Luce Visible Storage Room

id: integer

The id of the case and its case number

title: string

The title or name of the case

description: string

The description of the case

shelves: object[]

A collection of shelf objects within the case

LuceLocation: object

An object with information regarding the location of the luce object

id: integer

The luce id of the location

name: string

The display-friendly name of the location

case: integer

the case number if the location is within a case

sub_unit: string

the name of the location

LuceObject: object

An object with information about a piece in the Luce Collection. This information is specific to the Luce Center for American Art

id: integer

The id of the luce object

accession_number: string

The accession number of the luce object

location: LuceLocation
title: string

The name of the luce object

primary_artist: string
primary_artist_dating: string

A description of the primary artist, usually nationality and dates of life

date: string

A display-friendly date associated with the luce object

medium: string

The medium of the luce object

markings: string

A description of any markings found on the luce object

inscribed: string

Any inscribing on the luce object

signed: string

Any signature on the luce object

credit_line: string

A display-friendly phrase giving credit to the source of the luce object

description: string

A description of the luce object

artists_involved: object[]
curatorial_remarks: string

Any remarks about the object for the curatorial staff

primary_image: string

The filename of the luce object's image

LuceSubTheme: object

An object with information about a sub-theme that can only exist under a theme

id: integer

The sub-theme id

name: string

The name of the sub-theme

LuceSubThemeObjectCollection: object

An object containing an array of luce objects tied to a sub-theme

id: integer

The sub-theme id

objects: object[]

A collection of luce objects associated with the sub-theme

LuceTheme: object

An object with information about luce theme

id: integer

The id of the theme

name: string

The name of the theme

label: string

the label for a theme

sub_themes: object[]

An collection of sub-themes associated with the luce theme

LuceThemeObjectCollection: object

An object with arrays containing luce objects tied to a theme or its sub-themes

main_theme: object[]

An array of luce objects associated with a theme but no sub-theme

sub_themes: object[]

An array of sub-theme associated luce objects

MuseumLocation: object

An object with limited information about a location within the museum

id: integer

The id of the museum location

name: string

The name of the location

is_public: boolean

If the location is public or not

is_floor: boolean

If the location is a whole floor or not

NewTagResponse: object

An object containing information about newly created tag

tag_id: integer

The id of the newly created tag

session_id: integer

The id of the current user session

NotablePeriod: object

An object containing information about a notable period

year: string

The year or decade of the period

image_count: integer

The number of images from the period

Object: object

A JSON object with information about a museum object in the collection

id: integer

ID of the object

title: string

Title of the object

accession_number: string

The object's accession number

accession_date: string (date-time)

The date the object was accessioned

object_date: string (date-time)

Date of the object

object_date_begin: string (date-time)

The start date of the object

object_date_end: string (date-time)

The end date of the object

period: string

The period of the object if known

dynasty: string

The dynasty of the object if known or applicable

description: string

The catalogue desciption of the object. This description is a concise explanation of what the object is

medium: string

The medium of the object (e.g. materials object is made of)

dimensions: string

The dimenions of the object

edition: string

The edition information on the object. E.g. '4/5'

portfolio: string

The portfolio information for the object

state: string

The state of the object. E.g. 'Trial Proof', 'II/III'

markings: string

Information on any markings on the object

signed: string

Information on signature placement and/or content.

inscribed: string

Information on inscription placement and/or content.

credit_line: string

Information on aquisition credit

copyright: string

copyright

rights_statement: string

The rights statement for the object

classification: string

E.g. Photograph

public_access: integer

1 if the object is publicly accessible, 0 if not

approvals_mask: integer

The approvals mask value

copyright_restricted: integer

1 if copyright restricted. 0 if not

visible: integer

1 if visible. 0 if not

completeness: Completeness

On a scale of 0-100%, how complete is data regarding this object

date_added: string (date-time)

Date the object was added to the collection

museum_location: MuseumLocation

The location in the museum where the object is located

primary_image: string

The highest ranked (highest quality) image available for this object

labels: object[]

An array of text labels (such as more in depth object descriptions detailing the object's background, importance, and other historical information) associated with an object

artists: object[]

An array of artists who made the object

collections: object[]

An array of collections the object is a part of

exhibitions: object[]

An array of exhibitions the object has been, and currently is a part of

images: object[]

An array of images of the object, grouped by rank. Rank determines the relative importance of the images i.e. a lower rank corresponds with better image.

related_items: object[]

An array of objects related to the current object

geographical_locations: object[]

An array of geographical location data about the object

videos: object[]

An array of videos about the object

ObjectQuery: object

An object containing either an array of objects with information about Objects or a number indicating the total count

total_count: integer (int64)

A count of total maximum objects that can be returned from a given object query

objects: object[]

An array of the objects that meet the query parameters from a given query

PnaAbstract: object

An object containing information about a PnaAbstract

id: integer

ID of the abstract

page_count: integer

page count

web_theme: string

Web theme

doc_type: string

Document type

obj_year: string

Object year

obj_date: string

Object date

auth_fname: string

Author first name

auth_lname: string

Author last name

from_org: string

From organization

to_org: string

To organization

to_fname: string

To first name

to_lname: string

To last name

abstract: string

The text of the abstract

owner: string

The owner of the abstract

archive_name: string

The name of the archive the abstract is a part of

archive_id: integer

The id of the archive the abstract is a part of

images: object[]

Array of images associated with the abstract

PnaAbstractImage: object

An object containing information about a PnaAbstractImage

page_no: integer

The number of the page the image is representing

filename: string

The filename of the image

page_descr: string

The description of the page

img_abstract: string

Caption of the image

thumbnail_url: string

The url of the thumbnail version of the image

image_url: string

The url of the image

RelatedObject: object

An object containing information about related objects

id: integer

ID of the object

title: string

The title of the object

category: string

How this object relates to the searched object

primary_image: string

The filename of the primary image of this object

rank: integer

The rank of the primary image

is_color: boolean

If the primary image is color or not

load_date: string (date-time)

The load date of the primary image

ShortObject: object

A JSON object with limited information about an object in the museum collection

id: integer

ID of the object

title: string

Title of the object

accession_number: string

The object's accession number

primary_image: string

The highest ranked (highest quality) image available for this object

Tag: object

An object containing information about a tag

id: integer

ID of the tag

item_type: string

The type of item the tag is related to (e.g. object, artist, etc.)

item_id: string

The id of the item (so could be object id, artist id, etc.)

tag_text: string

The actual text of the tag

UserRegistration: object

An object containing information about a user registration

email: string

Email of the user signing up

first_name: string

The first name of the user

last_name: string

The last name of the user

employer: string

The name of user's employer

proposal: string

The user's reason for needing access to the api

api_type: string

The type of api access the user requires. Valid values are 'standard api' and 'OAI'

websites: string[]

An array of websites related to the user

string

Video: object

An object containing information about a video

id: integer

ID of the video

media_id: string

The ID of the video in relation to the service it is on. See video_type

video_type: string

The service the video is hosted on, e.g. Youtube