getDream
GET/dreams/:id
Get a single Dream.
Request
Path Parameters
id uuidrequired
Responses
- 200
- 404
- application/json
- Schema
- Example (from schema)
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 datenullable
Date 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
]
{
"dream": {
"id": "844830a8-b845-4cbc-b79f-865cd8c8aa8e",
"targetCents": 102000,
"type": "Dream",
"expiresAt": "2006-01-02",
"achievedAt": "2006-01-02T15:04:05Z",
"name": "Trip to Japan",
"balanceCents": 12300,
"deletedAt": "2006-01-02T15:04:05Z",
"imageUrl": "https://images.com/photo-123-456",
"activeSavehacksCount": 2,
"user": {
"type": "string",
"id": "string",
"externalId": "string"
},
"groupDream": {
"type": "string",
"id": "string"
},
"account": {
"type": "string",
"id": "string",
"externalId": "string"
},
"dreamInspiration": {
"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"
}
}
}
Dream not found
Loading...