Skip to main content

Get all Dreams in a paginated listing.​

Get all Dreams in a paginated listing.

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.

  • state string

    Possible values: [active, deleted]

    Filter dreams based on their state

    Example: deleted
  • showImageUrl boolean

    Possible values: [true, false]

    Return Image URL in response if set true

    Example: true
  • showActiveSavehacks boolean

    Possible values: [true, false]

    Return Number of active savehacks in response if set true

    Example: true
  • userId uuid

    Filter dreams to only include those with a userId equal to the supplied userId.

    Example: 844830a8-b845-4cbc-b79f-865cd8c8aa8e
  • externalUserId uuid

    Filter dreams to only include those with a externalUserId equal to the supplied externalUserId.

    Example: 844830a8-b845-4cbc-b79f-865cd8c8aa8e
Responses

All non-deleted Dreams in a paginated listing.

Schema
  • dreams object[]
  • Array [
  • id uuid
  • targetCents integer

    Represents how much money (in cents or the smallest currency subunit) the User wants to save to complete this Dream.

  • type string
  • expiresAt object

    (Optional) Date before which the User wants to complete this Dream.

  • achievedAt object

    Represents when the dream was completed

  • name string
  • balanceCents integer

    Current balance cents for dream

  • deletedAt object

    Represents when the dream was deleted

  • imageUrl string
  • activeSavehacksCount integer

    Current count of active savehacks

  • user object
  • type string required
  • id string required
  • externalId string
  • groupDream object

    (Optional) GroupDream this Dream is a part of.

  • type string required
  • id string required
  • account object

    Identifies the account where all money towards this dream is stored

  • type string required
  • id string required
  • externalId string
  • ]
  • 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.

Loading...