Skip to content

Search for publicly available collection shares

Request

This endpoint is unauthenticated. Do not send a Bearer Token in the Authorization Header

Bodyapplication/jsonrequired
fromintegerrequired

The item number to begin the result set from

Default:0
Example:0
pageSizeinteger, [ 0 .. 1000 ]required

The maximum number of items to return in the result set.

Default:100
Example:100
criterionany
sortsArray of objects

Sorts to be applied to the search in order of precedence

curl -i -X POST \
  https://api-v2.dash.app/publicly-available-collection-share-searches \
  -H 'Content-Type: application/json' \
  -d '{
    "from": 0,
    "pageSize": 100,
    "criterion": {
      "type": "FIELD_HAS_ITEMS",
      "value": "an item",
      "field": "SLUGS"
    },
    "sorts": [
      {
        "field": "ID",
        "order": "ASC"
      }
    ]
  }'

Responses

Success

Bodyapplication/json
resultsArray of objects

The specified page of CollectionShare resources which match the search criterion

totalResultsinteger

The total number of CollectionShare resources which match the search criterion

Example:15
Response
{ "results": [ {} ], "totalResults": 15 }