Skip Navigation

Opencollection API

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.

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

Arguments

limit
An integer indicating how many results to return Integer
offset
An integer indicating at which index of the full result set to begin at Integer
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. String
tag
Filter by tag. String
accession_number
Return objects with this accession number. Only returns exact matches. String
object_year_begin
Limit results to objects with dates after this year. String
object_year_end
Limit results to objects with dates before this year. String
title
Filter by title. String
portfolio
Filter by portfolio. String
description
Filter by description. String
medium
Filter by medium. String
dynasty
Filter by dynasty. String
exhibition_id
Filter by exhibition_id. String
location_id
Filter by location_id. Integer
geographical_location_id
Filter by id of geographical location. Integer
highlight
Limits the search to highlighted objects. Accepted values are 0 for false or 1 for true. Integer
collection_id
Limits the search to a collection. Integer
artist_id
Limits the search to a specific artist Integer
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. Integer
has_images
Accepted values are 0 for false or 1 for true. If true, only objects with images will be returned. Integer
on_view_only
Accepted values are 0 for false or 1 for true. If true, only objects that are on view will be returned. Integer
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. Integer
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. Integer
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. Integer
sort_by
If using the keyword parameter, can also sort results by either 'completeness' or 'relevance' using this parameter. String

Responses

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