Matrix Reminder and Calendar Bot (RemindMe) (2.1.1)

Download OpenAPI specification:Download

URL: https://github.com/CubicrootXYZ/matrix-reminder-and-calendar-bot

API documentation for the matrix reminder and calendar bot. Inprint & Privacy Policy

Channels

List all channels

Authorizations:

APIKeyAuthentication

Responses

Request samples

bash/curl
PHP
JavaScript

TOKEN="my secure token"
curl https://your-bot-domain.tld/core/channels -X GET -H "Authorization: ${TOKEN}"

Response samples

200
401

Content type

application/json

{"data": [{"createdAt": "string",
"dailyReminder": "string",
"description": "string",
"id": 0
}
],
"status": "success"
}

Calendars

Get calendar (iCal)

Get calendar as iCal

path Parameters

id

required

integer

iCal output ID

query Parameters

token

required

string

authentication token

Responses

Request samples

bash/curl
PHP
JavaScript

curl https://your-bot-domain.tld/ical/1234?token=example-string -X GET

Matrix

List all Input Rooms

List all matrix rooms acting as an input for the given channel.

Authorizations:

APIKeyAuthentication

path Parameters

id

required

string

Channel ID

Responses

Request samples

bash/curl
PHP
JavaScript

TOKEN="my secure token"
curl https://your-bot-domain.tld/matrix/channels/example-string/inputs/rooms -X GET -H "Authorization: ${TOKEN}"

Response samples

200
400
401
404

Content type

application/json

{"data": [{"created_at": "string",
"id": 0,
"room_id": "string",
"users": [{"blocked": true,
"id": "string"
}
]
}
],
"status": "success"
}

List all Output Rooms

List all matrix rooms acting as an output for the given channel.

Authorizations:

APIKeyAuthentication

path Parameters

id

required

string

Channel ID

Responses

Request samples

bash/curl
PHP
JavaScript

TOKEN="my secure token"
curl https://your-bot-domain.tld/matrix/channels/example-string/outputs/rooms -X GET -H "Authorization: ${TOKEN}"

Response samples

200
400
401
404

Content type

application/json

{"data": [{"created_at": "string",
"id": 0,
"room_id": "string",
"users": [{"blocked": true,
"id": "string"
}
]
}
],
"status": "success"
}