---
updatedAt: 2026-03-31T12:12:41.000Z
agentTools:
  projectIndex: https://api.net2grid.com/llms.txt
---

# /messages

Get the users' messages.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "NET2GRID Customer Engagement API",
    "description": "This is the B2C NET2GRID API that can be used by mobile and web apps to manage the accounts and the data that are provided by the NET2GRID Meter Data Analytics Platform.",
    "version": "13.6.0"
  },
  "servers": [
    {
      "url": "http://api.net2grid.docker",
      "description": "API server"
    }
  ],
  "paths": {
    "/v2/messages": {
      "get": {
        "tags": [
          "Notifications"
        ],
        "summary": "/messages",
        "description": "Get the users' messages.",
        "operationId": "v2/getInboxMessages",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetMessagesResponseDTO"
                },
                "examples": {
                  "GetMessagesExample": {
                    "$ref": "#/components/examples/GetMessagesExample"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid request<br/>400: Resource not found<br/>999: Unspecified Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDTO"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "GetMessagesDataDTO": {
        "properties": {
          "object_id": {
            "description": "The object_id for the specific message, the same message_code can appear multiple times",
            "type": "integer"
          },
          "message_code": {
            "description": "The identifier for the specific message",
            "type": "string"
          },
          "is_read": {
            "description": "Indicates the current message status, if it is read or not",
            "type": "integer"
          },
          "timestamp": {
            "description": "The time the message was sent to the user (in Y-m-dTH:i:s+timezone for example: 2016-09-07T19:27:08+02:00)",
            "type": "string"
          },
          "category": {
            "description": "The category of the inbox message. Can be report|system",
            "type": "string"
          },
          "attributes": {
            "description": "Optional array of key/value attributes",
            "type": "object"
          },
          "attachments": {
            "description": "Optional object of key/value attributes. Key can be used to specify the name of the downloaded file",
            "type": "object"
          }
        },
        "type": "object"
      },
      "GetMessagesResponseDTO": {
        "properties": {
          "status": {
            "type": "string"
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GetMessagesDataDTO"
            }
          }
        },
        "type": "object"
      },
      "ErrorDTO": {
        "properties": {
          "code": {
            "type": "integer"
          },
          "message": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "ErrorResponseDTO": {
        "properties": {
          "status": {
            "type": "string"
          },
          "error": {
            "$ref": "#/components/schemas/ErrorDTO"
          }
        },
        "type": "object"
      }
    },
    "examples": {
      "GetMessagesExample": {
        "summary": "Get Messages Response",
        "value": {
          "status": "ok",
          "data": [
            {
              "object_id": 1,
              "message_code": "M019",
              "is_read": 0,
              "timestamp": "2022-05-30T06:06:30+02:00",
              "category": "report",
              "attributes": [
                {
                  "attribute1_name": "attribute1_value"
                }
              ],
              "attachments": []
            }
          ]
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "bearerFormat": "JWT",
        "scheme": "bearer"
      }
    }
  },
  "tags": [
    {
      "name": "Notifications"
    }
  ],
  "x-explorer-enabled": false
}
```