Skip Navigation

Opencollection API

GET /archive/image/

Return a list of archive images

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

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
type
Filter by type of set. Valid values are either 'library' or 'archives' String
archives_collection_id
Filter by images associated with the given archive collection id Integer
archives_set_id
Filter by images associated with the given archive set id Integer
country
Filter by images that are from the given country String
date
Filter by images that are from the given date String
tag
Filter by tag. String
caption
Filter by caption String
credit
Filter by credit String
title
Filter by title of related archive set String
rights_type_permissive
Filter by images that have a permissive copyright status Boolean
keyword
Filter by keyword. This is a full text search of the archive image fields. 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. Integer

Responses

200: 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 Returns ArchiveImage