> For the complete documentation index, see [llms.txt](https://user.netmera.com/netmera-developer-guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://user.netmera.com/netmera-developer-guide/api-documentation/rest-api/inbox-feature.md).
# Inbox Feature
Netmera’s REST Inbox API allows you to fetch, display, and manage push notifications stored on the server. It supports pagination, filtering by status or time range, and updating message states (e.g., read, deleted).
### Inbox Retrieval
Fetches the push notifications stored on the server for a user. Supports pagination and filtering by status or time range.
#### Using Pagination (via `prms.index`)
After the first call, the response returns a `prms.index` value — the `pushInstanceId` of the last message in that batch. Pass that value as `prms.index` in the next request to fetch the next page.
A response without a `prms.index` means there are no further pages.
Both requests are available as the `paginationPage1` and `paginationPage2` examples on the operation below.
## inbox/getAllInbox
> Fetches the push notifications stored on the server for a user. Supports pagination and\
> filtering by status or time range.
```json
{"openapi":"3.1.0","info":{"title":"Netmera REST API","version":"3.0"},"tags":[{"name":"Inbox","description":"Fetch, display and manage push notifications stored on the server."}],"servers":[{"url":"https://restapi.netmera.com","description":"Netmera REST API"}],"security":[{"NetmeraApiKey":[]}],"components":{"securitySchemes":{"NetmeraApiKey":{"type":"apiKey","in":"header","name":"X-netmera-api-key","description":"REST API key. Available in the Netmera Panel under Developers > API.\n"}},"schemas":{"InboxRequest":{"type":"object","required":["extId","status"],"properties":{"extId":{"type":"string","description":"The unique external ID of the user."},"status":{"type":"integer","description":"Filters the messages based on read status. Accepted values: 1 = Read, 2 = Unread,\n3 = Read & Unread, 4 = Deleted, 7 = All.\n"},"numberOfNotification":{"type":"integer","description":"Defines the number of messages to return per page. Defaults to 20 if not provided.\n"},"prms":{"type":"object","description":"Pagination block.","properties":{"index":{"type":"integer","format":"int64","description":"The `pushInstanceId` of the last message received in the previous response.\n"}}},"startDate":{"type":"integer","format":"int64","description":"Filters messages starting from this date. Epoch timestamp in milliseconds.\n"},"endDate":{"type":"integer","format":"int64","description":"Filters messages until this date. Epoch timestamp in milliseconds.\n"},"category":{"type":"array","description":"Filters messages by categories.","items":{"type":"integer"}}}},"InboxListResponse":{"type":"object","properties":{"msgs":{"type":"array","items":{"$ref":"#/components/schemas/InboxMessage"}},"cnts":{"type":"object","description":"Message counts keyed by status value. The last page of a paginated result omits the\n`prms` block.\n","additionalProperties":{"type":"integer"}},"prms":{"type":"object","properties":{"index":{"type":"integer","format":"int64","description":"The `pushInstanceId` of the last message in this batch, passed as `prms.index`\nin the next request.\n"}}}}},"InboxMessage":{"type":"object","properties":{"msgId":{"type":"integer"},"pushInstanceId":{"type":"integer","format":"int64"},"title":{"type":"string"},"message":{"type":"string"},"status":{"type":"string"},"sts":{"type":"integer","format":"int64"},"subText":{"type":"string"}},"additionalProperties":true}}},"paths":{"/rest/3.0/inbox/getAllInbox":{"post":{"operationId":"getAllInbox","tags":["Inbox"],"summary":"inbox/getAllInbox","description":"Fetches the push notifications stored on the server for a user. Supports pagination and\nfiltering by status or time range.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxRequest"}}}},"responses":{"200":{"description":"The user's inbox messages.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxListResponse"}}}}}}}}}
```
### Retrieve a Single Inbox Message
## inbox/get
> Retrieves a single inbox message using its push instance ID.
```json
{"openapi":"3.1.0","info":{"title":"Netmera REST API","version":"3.0"},"tags":[{"name":"Inbox","description":"Fetch, display and manage push notifications stored on the server."}],"servers":[{"url":"https://restapi.netmera.com","description":"Netmera REST API"}],"security":[{"NetmeraApiKey":[]}],"components":{"securitySchemes":{"NetmeraApiKey":{"type":"apiKey","in":"header","name":"X-netmera-api-key","description":"REST API key. Available in the Netmera Panel under Developers > API.\n"}},"schemas":{"InboxMessageDetail":{"type":"object","properties":{"msgId":{"type":"integer"},"extID":{"type":"string"},"pushInstanceId":{"type":"integer","format":"int64"},"title":{"type":"string"},"message":{"type":"string"},"deeplink":{"type":["string","null"]},"androidMediaUrl":{"type":["string","null"]},"iosMediaUrl":{"type":["string","null"]},"androidThumbnail":{"type":["string","null"]},"personalizedMsg":{"type":["string","null"]},"personalizedTitle":{"type":["string","null"]},"subText":{"type":["string","null"]},"status":{"type":"string"},"customParams":{"type":"object","additionalProperties":true},"sts":{"type":"integer","format":"int64"},"ctg":{"type":"array","description":"Categories.","items":{}},"lbl":{"type":"array","description":"Labels.","items":{}}},"additionalProperties":true}}},"paths":{"/rest/3.0/inbox/get":{"get":{"operationId":"getInboxMessage","tags":["Inbox"],"summary":"inbox/get","description":"Retrieves a single inbox message using its push instance ID.","parameters":[{"name":"piid","in":"query","required":true,"description":"Push instance ID of the inbox message, returned in the `getAllInbox` response.\n","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"The inbox message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxMessageDetail"}}}}}}}}}
```
### Change Message Status
## inbox/statusChange
> Updates the status of one or more inbox messages. \`piids\` defines the messages whose\
> statuses will be updated.
```json
{"openapi":"3.1.0","info":{"title":"Netmera REST API","version":"3.0"},"tags":[{"name":"Inbox","description":"Fetch, display and manage push notifications stored on the server."}],"servers":[{"url":"https://restapi.netmera.com","description":"Netmera REST API"}],"security":[{"NetmeraApiKey":[]}],"components":{"securitySchemes":{"NetmeraApiKey":{"type":"apiKey","in":"header","name":"X-netmera-api-key","description":"REST API key. Available in the Netmera Panel under Developers > API.\n"}}},"paths":{"/rest/3.0/inbox/statusChange":{"post":{"operationId":"inboxStatusChange","tags":["Inbox"],"summary":"inbox/statusChange","description":"Updates the status of one or more inbox messages. `piids` defines the messages whose\nstatuses will be updated.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["extId","piids"],"properties":{"extId":{"type":"string","description":"The unique external ID of the user."},"piids":{"type":"array","description":"Push instance IDs of the messages to update.","items":{"type":"integer"}},"st":{"type":"integer","description":"Target status. Status values used by the Inbox API are 1 = Read,\n2 = Unread, 3 = Read & Unread, 4 = Deleted, 7 = All.\n"}}}}}},"responses":{"200":{"description":"The statuses were updated. Returns no response body.\n"}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## 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, and the optional `goal` query parameter:
```
GET https://user.netmera.com/netmera-developer-guide/api-documentation/rest-api/inbox-feature.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
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.