Skip to main content

getDream

GET 
/dreams/:id

Get a single Dream.

Request​

Path Parameters

    id uuidrequired

Responses​

Schema

    dream

    object

    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 RFC3339

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

    achievedAt RFC3339

    Represents when the dream was completed

    name string
    balanceCents integer

    Current balance cents for dream

    deletedAt RFC3339

    Represents when the dream was deleted

    imageUrl string
    activeSavehacksCount integer

    Current count of active savehacks

    user

    object

    type stringrequired
    id stringrequired
    externalId string

    groupDream

    object

    (Optional) GroupDream this Dream is a part of.

    type stringrequired
    id stringrequired

    account

    object

    Identifies the account where all money towards this dream is stored

    type stringrequired
    id stringrequired
    externalId string

    dreamInspiration

    object

    nullable

    (Optional) The Dream Inspiration this Dream was created from.

    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]

Loading...