sfomuseum.you.shoebox.listItems
Description
List items in a user's shoebox Try this method in the API Explorer.
HTTP Request method
GET
Arguments
- access_token (
string) — A valid OAuth2 access token (required) - format (
string) — The format in which to return the data. Supported formats are json, jsonp. The default format is json. - min_date (
int64) — The minimum date (encoded as a Unix timestamp) that an item was to the shoebox. - max_date (
int64) — The maximum date (encoded as a Unix timestamp) that an item was to the shoebox. - sort (
string) — Sort shoebox items in ascending (ASC) or descending (DESC) order. Default is DESC. - page (
int) — The default is 1. - per_page (
int) — The default is 100 and the maximum is 500.
Errors
In addition to default error codes common to all methods this API method defines the following additional error codes:
900— Failed to list shoebox items
Notes
- This API method uses plain pagination. Please consult the pagination documentation for details.
Example request — or take this API method for a spin
curl -X GET 'https://api.sfomuseum.org/rest/?method=sfomuseum.you.shoebox.listItems&access_token=<TOKEN>&min_date=<MIN_DATE>&max_date=<MAX_DATE>&sort=<SORT>'