--- title: "Get inbox messages" method: GET path: "/v1/smart_rollups/inbox" tags: ["SmartRollups"] --- # Get inbox messages `GET /v1/smart_rollups/inbox` Returns a list of smart rollup inbox messages. ## Query parameters - `id` Int32Parameter - `eq` integer, nullable — **Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \ Specify an integer number to get items where the specified field is equal to the specified value. Example: `?balance=1234`. - `ne` integer, nullable — **Not equal** filter mode. \ Specify an integer number to get items where the specified field is not equal to the specified value. Example: `?balance.ne=1234`. - `gt` integer, nullable — **Greater than** filter mode. \ Specify an integer number to get items where the specified field is greater than the specified value. Example: `?balance.gt=1234`. - `ge` integer, nullable — **Greater or equal** filter mode. \ Specify an integer number to get items where the specified field is greater than equal to the specified value. Example: `?balance.ge=1234`. - `lt` integer, nullable — **Less than** filter mode. \ Specify an integer number to get items where the specified field is less than the specified value. Example: `?balance.lt=1234`. - `le` integer, nullable — **Less or equal** filter mode. \ Specify an integer number to get items where the specified field is less than or equal to the specified value. Example: `?balance.le=1234`. - `in` integer[], nullable — **In list** (any of) filter mode. \ Specify a comma-separated list of integers to get items where the specified field is equal to one of the specified values. Example: `?level.in=12,14,52,69`. - `ni` integer[], nullable — **Not in list** (none of) filter mode. \ Specify a comma-separated list of integers to get items where the specified field is not equal to all the specified values. Example: `?level.ni=12,14,52,69`. - `level` Int32Parameter - `eq` integer, nullable — **Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \ Specify an integer number to get items where the specified field is equal to the specified value. Example: `?balance=1234`. - `ne` integer, nullable — **Not equal** filter mode. \ Specify an integer number to get items where the specified field is not equal to the specified value. Example: `?balance.ne=1234`. - `gt` integer, nullable — **Greater than** filter mode. \ Specify an integer number to get items where the specified field is greater than the specified value. Example: `?balance.gt=1234`. - `ge` integer, nullable — **Greater or equal** filter mode. \ Specify an integer number to get items where the specified field is greater than equal to the specified value. Example: `?balance.ge=1234`. - `lt` integer, nullable — **Less than** filter mode. \ Specify an integer number to get items where the specified field is less than the specified value. Example: `?balance.lt=1234`. - `le` integer, nullable — **Less or equal** filter mode. \ Specify an integer number to get items where the specified field is less than or equal to the specified value. Example: `?balance.le=1234`. - `in` integer[], nullable — **In list** (any of) filter mode. \ Specify a comma-separated list of integers to get items where the specified field is equal to one of the specified values. Example: `?level.in=12,14,52,69`. - `ni` integer[], nullable — **Not in list** (none of) filter mode. \ Specify a comma-separated list of integers to get items where the specified field is not equal to all the specified values. Example: `?level.ni=12,14,52,69`. - `timestamp` TimestampParameter - `eq` string, date-time, nullable — **Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \ Specify a datetime value to get items where the specified field is equal to the specified value. Example: `?timestamp=2020-02-20T02:40:57Z`. - `ne` string, date-time, nullable — **Not equal** filter mode. \ Specify a datetime value to get items where the specified field is not equal to the specified value. Example: `?timestamp.ne=2020-02-20T02:40:57Z`. - `gt` string, date-time, nullable — **Greater than** filter mode. \ Specify a datetime value to get items where the specified field is greater than the specified value. Example: `?timestamp.gt=2020-02-20T02:40:57Z`. - `ge` string, date-time, nullable — **Greater or equal** filter mode. \ Specify a datetime value to get items where the specified field is greater than equal to the specified value. Example: `?timestamp.ge=2020-02-20T02:40:57Z`. - `lt` string, date-time, nullable — **Less than** filter mode. \ Specify a datetime value to get items where the specified field is less than the specified value. Example: `?timestamp.lt=2020-02-20T02:40:57Z`. - `le` string, date-time, nullable — **Less or equal** filter mode. \ Specify a datetime value to get items where the specified field is less than or equal to the specified value. Example: `?timestamp.le=2020-02-20T02:40:57Z`. - `in` string[], nullable — **In list** (any of) filter mode. \ Specify a comma-separated list of datetimes to get items where the specified field is equal to one of the specified values. Example: `?timestamp.in=2020-02-20,2020-02-21`. - `ni` string[], nullable — **Not in list** (none of) filter mode. \ Specify a comma-separated list of datetimes to get items where the specified field is not equal to all the specified values. Example: `?timestamp.ni=2020-02-20,2020-02-21`. - `type` SrMessageTypeParameter - `eq` string, nullable — **Equal** filter mode (`.eq` suffix can be omitted, i.e. `?param=...` is the same as `?param.eq=...`). \ Specify an inbox message type to get items where the specified field is equal to the specified value. Example: `?status=external`. - `ne` string, nullable — **Not equal** filter mode. \ Specify an inbox message type to get items where the specified field is not equal to the specified value. Example: `?status.ne=transfer`. - `in` string[], nullable — **In list** (any of) filter mode. \ Specify a comma-separated list of inbox message types to get items where the specified field is equal to one of the specified values. Example: `?status.in=transfer,external`. - `ni` string[], nullable — **Not in list** (none of) filter mode. \ Specify a comma-separated list of inbox message types to get items where the specified field is not equal to all the specified values. Example: `?status.ni=transfer,external`. - `sort` SortParameter - `asc` string, nullable — **Ascending** sort mode (optional, i.e. `sort.asc=id` is the same as `sort=id`). \ Specify a field name to sort by. Example: `?sort=balance`. - `desc` string, nullable — **Descending** sort mode. \ Specify a field name to sort by descending. Example: `?sort.desc=id`. - `offset` OffsetParameter - `el` integer, nullable — **Elements** offset mode (optional, i.e. `offset.el=123` is the same as `offset=123`). \ Skips specified number of elements. Example: `?offset=100`. - `pg` integer, nullable — **Page** offset mode. \ Skips `page * limit` elements. This is a classic pagination. Example: `?offset.pg=1`. - `cr` integer, nullable — **Cursor** offset mode. \ Skips all elements with the `cursor` before (including) the specified value. Cursor is a field used for sorting, e.g. `id`. Avoid using this offset mode with non-unique or non-sequential cursors such as `amount`, `balance`, etc. Example: `?offset.cr=45837`. - `limit` integer - `select` SelectionParameter - `fields` string[], nullable — **Fields** selection mode (optional, i.e. `select.fields=balance` is the same as `select=balance`). \ Specify a comma-separated list of fields to include into response. Example: `?select=address,balance as b,metadata.name as meta_name` will result in `[ { "address": "asd", "b": 10, "meta_name": "qwe" } ]`. - `values` string[], nullable — **Values** selection mode. \ Specify a comma-separated list of fields to include their values into response. Example: `?select.values=address,balance,metadata.name` will result in `[ [ "asd", 10, "qwe" ] ]`. - `micheline` 'Json' | 'JsonString' | 'Raw' | 'RawString' ## Response `200` - SrMessage[] - `id` integer — Internal TzKT id. **[sortable]** - `level` integer — Level of the block where the message was pushed. **[sortable]** - `index` integer — Index of the inbox message within the block. - `timestamp` string, date-time — Timestamp of the block where the message was pushed. - `type` string, required — Type of the message (`level_start`, `level_info`, `level_end`, `transfer`, `external`, `migration`). - `predecessorHash` string, nullable — For `level_info` messages only. Hash of the predecessor block. - `predecessorTimestamp` string, date-time, nullable — For `level_info` messages only. Timestamp of the predecessor block. - `initiator` Alias - `alias` string, nullable — Account alias name (off-chain data). - `address` string, required — Account address (public key hash). - `sender` Alias - `alias` string, nullable — Account alias name (off-chain data). - `address` string, required — Account address (public key hash). - `target` Alias - `alias` string, nullable — Account alias name (off-chain data). - `address` string, required — Account address (public key hash). - `entrypoint` string, nullable — For `transfer` messages only. Entrypoint called in the target rollup - `parameter` unknown - `payload` string, byte, nullable — For `external` messages only. Payload bytes (in base64). - `protocol` string, nullable — For `migration` messages only. Version of the new protocol (e.g. 'nairobi_017'). --- [API](https://skmtc.dev/tzkt/apis/tzkt-api.md) · [All operations](https://skmtc.dev/tzkt/apis/tzkt-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/tzkt/tzkt-api/revisions/a2e2aba5e534/schema)