About this endpoint
What it does
Searches for artworks using the provided query filters and returns a paginated list of matching artworks. The response includes the requested number, offset, a collection of artworks, and the total available count.
Query Parameter(s)
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| type | String | No | Artwork type filter. Pattern: any string, max length 1000. |
| query | String | Yes | Search text. Pattern: any string, max length 300. |
| number | Integer | No | Number of results to return. Minimum 1, maximum 10. |
| offset | Integer | No | Pagination offset. Minimum 0, maximum 1000. |
| origin | String | No | Origin filter. Pattern: any string, max length 100. |
| material | String | No | Material filter. Pattern: any string, max length 1000. |
| max-ratio | Number | No | Maximum ratio filter. Minimum 0, maximum 10. |
| min-ratio | Number | No | Minimum ratio filter. Minimum 0, maximum 10. |
| technique | String | No | Technique filter. Pattern: any string, max length 13. |
| latest-end-date | Integer | No | Latest end date filter. |
| earliest-end-date | Integer | No | Earliest end date filter. |
| latest-start-date | Integer | No | Latest start date filter. |
| earliest-start-date | Integer | No | Earliest start date filter. |
Response
Returns a JSON object with number and offset integers, an artworks array of objects, and an available integer. Each artwork item contains an id integer, plus nullable image and title string fields.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| number | Integer | No | Number value echoed in the response. |
| offset | Integer | No | Offset value echoed in the response. |
| artworks | Object Array | No | List of matching artworks. Each item contains id, image, and title. |
| artworks[].id | Integer | No | Artwork identifier. |
| artworks[].image | String | No | Artwork image URL or value; nullable. |
| artworks[].title | String | No | Artwork title; nullable. |
| available | Integer | No | Total number of artworks available for the given search criteria. |



