Skip to main content

getMessages​

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

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
Responses

All messages in a paginated listing.

Schema
  • messages object[]
  • Array [
  • type string required

    Possible values: [Message]

  • id string required
  • user object required
  • type string required
  • id string required
  • externalId string
  • translatedTitle object
  • [locale] string
  • translatedBody object required
  • [locale] string
  • image object
  • src string required

    Image URL

  • translatedAlt object
  • [locale] string
  • height integer

    Height of the image in pixels.

  • width integer

    Width of the image in pixels.

  • cta string required
  • createdAt RFC3339 required
  • processedAt RFC3339 required
  • external boolean required
  • ]
  • 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...