Search for collections

Request

Create a new CollectionSearch

The most commmon use of an CollectionSearch is to retrieve all the Collection resources associated with a User

Security

bearerToken

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/collection-searches \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "from": 0,
    "pageSize": 100,
    "criterion": {
      "type": "ASSOCIATED_WITH_USER",
      "userId": "google-oauth2|110955770826801837334"
    },
    "sorts": [
      {
        "field": "NAME",
        "order": "ASC"
      }
    ]
  }'

Responses

Success

Bodyapplication/json

resultsArray of objects

The specified page of Collection resources which match the search criterion

totalResultsinteger

The total number of Collection resources which match the search criterion

Example:15

Response

{
  "results": [
    { … },
    { … },
    { … }
  ],
  "totalResults": 3
}