Skip to main content

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.123456Z
    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​

All messages in a paginated listing.

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.

Loading...