getDreamInspirations

GET 
/dream-inspirations

Get all Dream Inspirations in a paginated listing.

Request

Query Parameters

page integer

Possible values: >= 1

Default value: 1

The page number in a paginated listing.

items integer

Possible values: >= 1 and <= 20

Default value: 20

The number of items to return on each page.

Responses

200

Requested page of dream inspirations

application/json

Schema

Schema

dreamInspirations

object[]

Array [

id uuidrequired

translatedName

object

[locale] string

targetCents integer

Possible values: >= 1 and <= 9223372036854776000

Default value: 0

durationSeconds integer

imageUrl string

type stringrequired

Possible values: [DreamInspiration]

]

meta

object

next_url url

URL for the next page.

count integer

The total count of items.

items integer

The number of returned items on this page.

pages integer

The number of pages.

from integer

Index of the first item on this page (starting from 1).

to integer

Index of the last item on this page.

Example (from schema)

{
  "dreamInspirations": [
    {
      "id": "844830a8-b845-4cbc-b79f-865cd8c8aa8e",
      "translatedName": {
        "en": "Translated string with %{interpolations} for the `en` locale",
        "xx": "Or any other locale you wish to support"
      },
      "targetCents": 5000,
      "durationSeconds": "string",
      "imageUrl": "string",
      "type": "DreamInspiration"
    }
  ],
  "meta": true
}

Loading...