getMessages

GET 
/messages

Get all Messages in a paginated listing, sorted by ascending createdAt.

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.

createdAfter RFC3339
Filter Messages to only include those with a createdAt timestamp strictly greater than createdAfter. Useful for polling and batch processing; iterate over all Messages, and filter each request by createdAt of the latest processed Message.
Example: 2023-05-07T14:21:56.123Z
state string
Possible values: [processed, unprocessed]
Filter Messages to only include/exclude those with a processedAt timestamp. Useful for processing.
Example: processed
external boolean
Possible values: [true, false]
Filter to only return external or internal Messages
Example: true
subtype string

Possible values: [ONBOARDING_ONE, ONBOARDING_TWO, UPSELL_AUTOSAVE_ONE, UPSELL_AUTOSAVE_TWO, UPSELL_AUTOSAVE_THREE, REACTIVATION_ONE, REACTIVATION_TWO, REACTIVATION_THREE, WELLBEING_QUESTION_ONE]

Responses

200

All messages in a paginated listing.

application/json

Schema

Schema

messages

object[]

Array [

type stringrequired

Possible values: [Message]

id stringrequired

user

object

required

type stringrequired

id stringrequired

externalId string

translatedTitle

object

[locale] string

translatedBody

object

required

[locale] string

image

object

src stringrequired

Image URL

translatedAlt

object

[locale] string

height integer

Height of the image in pixels.

width integer

Width of the image in pixels.

cta stringrequired

createdAt RFC3339required

processedAt RFC3339required

external booleanrequired

subtype string

Possible values: [ONBOARDING_ONE, ONBOARDING_TWO, UPSELL_AUTOSAVE_ONE, UPSELL_AUTOSAVE_TWO, UPSELL_AUTOSAVE_THREE, REACTIVATION_ONE, REACTIVATION_TWO, REACTIVATION_THREE, WELLBEING_QUESTION_ONE]

]

meta

object

next_url url

URL for the next page.

items integer

The number of returned items on this page.

Example (from schema)

{
  "messages": [
    {
      "id": "11785037-908d-41f5-875c-ceea9fb5c2f5",
      "type": "Message",
      "user": {
        "type": "User",
        "id": "cb66889a-8a8b-4d6b-81a3-fcf2340e838a",
        "externalId": "usr_12345"
      },
      "translatedTitle": {
        "en": "Save more toward Electric Car"
      },
      "translatedBody": {
        "en": "Save every day, week or month without having to think about it. Go to Impact Finance in the app to try automatic savehacks."
      },
      "image": {
        "src": "https://assets.dreams.enterprises/rails/.../image.jpg",
        "translatedAlt": {
          "en": "Your Dream"
        },
        "height": 144,
        "width": 144
      },
      "cta": "/dreams/de2706a8-6853-479a-9b61-ed9d1c91010d/marketplace",
      "createdAt": "2023-05-07T14:21:56.123Z",
      "processedAt": "2023-05-07T15:21:56.123Z",
      "external": true
    }
  ],
  "meta": true
}

Loading...