MAmatrix
Room participation

Get the user's current state.

This returns the full state for this user, with an optional limit on the number of messages per room to return.

This endpoint was deprecated in r0 of this specification. Clients should instead call the /sync endpoint with no since parameter. See the migration guide.

get/_matrix/client/v3/initialSync

Request

Query parameters

limitinteger

The maximum number of messages to return for each room.

archivedboolean

Whether to include rooms that the user has left. If false then only rooms that the user has been invited to or has joined are included. If set to true then rooms that the user has left are included as well. By default this is false.

Response

The user's current state.

endstring required

A token which correlates to the end of the timelines returned. This token should be used with the /events endpoint to listen for new events.

Example response

{
  "rooms": [
    {
      "invite": {
        "content": {
          "membership": "join"
        },
        "event_id": "$26RqwJMLw-yds1GAH_QxjHRC1Da9oasK0e5VLnck_45",
        "origin_server_ts": 1632489532305,
        "sender": "@example:example.org",
        "state_key": "@user:example.org",
        "type": "m.room.member",
        "unsigned": {
          "age": 1567437,
          "membership": "join",
          "redacted_because": {
            "content": {
              "reason": "spam"
            },
            "event_id": "$Nhl3rsgHMjk-DjMJANawr9HHAhLg4GcoTYrSiYYGqEE",
            "origin_server_ts": 1632491098485,
            "redacts": "$26RqwJMLw-yds1GAH_QxjHRC1Da9oasK0e5VLnck_45",
            "room_id": "!jEsUZKDJdhlrceRyVU:example.org",
            "sender": "@moderator:example.org",
            "type": "m.room.redaction",
            "unsigned": {
              "age": 1257
            }
          }
        },
        "room_id": "!jEsUZKDJdhlrceRyVU:example.org"
      },
      "messages": {
        "chunk": [
          {
            "content": {
              "membership": "join"
            },
            "event_id": "$26RqwJMLw-yds1GAH_QxjHRC1Da9oasK0e5VLnck_45",
            "origin_server_ts": 1632489532305,
            "sender": "@example:example.org",
            "state_key": "@user:example.org",
            "type": "m.room.member",
            "unsigned": {
              "age": 1567437,
              "membership": "join",
              "redacted_because": {
                "content": {
                  "reason": "spam"
                },
                "event_id": "$Nhl3rsgHMjk-DjMJANawr9HHAhLg4GcoTYrSiYYGqEE",
                "origin_server_ts": 1632491098485,
                "redacts": "$26RqwJMLw-yds1GAH_QxjHRC1Da9oasK0e5VLnck_45",
                "room_id": "!jEsUZKDJdhlrceRyVU:example.org",
                "sender": "@moderator:example.org",
                "type": "m.room.redaction",
                "unsigned": {
                  "age": 1257
                }
              }
            },
            "room_id": "!jEsUZKDJdhlrceRyVU:example.org"
          }
        ]
      },
      "state": [
        {
          "content": {
            "membership": "join"
          },
          "event_id": "$26RqwJMLw-yds1GAH_QxjHRC1Da9oasK0e5VLnck_45",
          "origin_server_ts": 1632489532305,
          "sender": "@example:example.org",
          "state_key": "@user:example.org",
          "type": "m.room.member",
          "unsigned": {
            "age": 1567437,
            "membership": "join",
            "redacted_because": {
              "content": {
                "reason": "spam"
              },
              "event_id": "$Nhl3rsgHMjk-DjMJANawr9HHAhLg4GcoTYrSiYYGqEE",
              "origin_server_ts": 1632491098485,
              "redacts": "$26RqwJMLw-yds1GAH_QxjHRC1Da9oasK0e5VLnck_45",
              "room_id": "!jEsUZKDJdhlrceRyVU:example.org",
              "sender": "@moderator:example.org",
              "type": "m.room.redaction",
              "unsigned": {
                "age": 1257
              }
            }
          },
          "room_id": "!jEsUZKDJdhlrceRyVU:example.org"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.