# List Messages API

## Overview

{% openapi src="<https://api.postman.gov.sg/openapi.yaml>" path="/transactional/govsg" method="get" %}
<https://api.postman.gov.sg/openapi.yaml>
{% endopenapi %}

## Response format

* `has_more`: a boolean indicating whether there are more WhatsApp messages to retrieve.
* `data`: an array of JSON WhatsApp message objects. You can find an example of a single JSON message object [here](/email-api-guide/programmatic-govsg-api/get-message-by-id-api.md).

### Example response

```json
{
  "has_more": false,
  "data": [
    {
      "id": "505",
      "recipient": "+6581489408",
      "template_id": "1",
      "params": {
        "topic": "document collection",
        "agency": "Open Government Products",
        "timeslot": "1-3PM",
        "officer_name": "John Tan",
        "recipient_name": "Stanley Nguyen",
        "officer_designation": "Reception Officer"
      },
      "language_code": "en_GB",
      "created_at": "2023-07-31T16:39:59.631Z",
      "updated_at": "2023-07-31T16:40:02.558Z",
      "accepted_at": "2023-07-31T16:40:01.526Z",
      "sent_at": "2023-07-31T16:40:01.000Z",
      "delivered_at": "2023-07-31T16:40:02.000Z",
      "read_at": null,
      "errored_at": null,
      "error_code": null,
      "error_description": null,
      "status": "DELIVERED"
    }
  ]
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://postman-v1.guides.gov.sg/email-api-guide/programmatic-govsg-api/list-messages-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.