Skip to main content

getSavehackLaunches

GET 

/savehack-launches

Get all Savehack Launches 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.

    dreamId uuid

    Filter savehack launches to only include those with a dreamId equal to the supplied dreamId.

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

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

    Example: 4c4a444b-b845-4cbc-b79f-865cd8c8aa8e
    externalUserId string

    Filter savehack launches by externalUserId

Responses

All savehack launches in a paginated listing.

Schema

    savehackLaunches

    object[]

  • Array [

  • oneOf

    id uuidrequired

    dream

    object

    required

    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

    savehack

    object

    required

    type stringrequired
    id stringrequired
    stoppedAt RFC3339nullable
    pausedAt RFC3339nullable

    dreamInspiration

    object

    nullable

    (Optional) The Dream Inspiration associated with this launch's Dream.

    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]

    type stringrequired

    Possible values: [AutopilotLaunch]

  • ]

  • 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...