Skip to content

Get events from URL​

POST
/api/ics-import/url

Convert ICS data from URL to event objects. Anonymous users are allowed only when anonymous events are enabled. Only http(s) URLs on default ports pointing to public addresses are fetched.

Request Body​

application/json
JSON
{
  
"url": "https://example.org/calendar.ics",
  
"includePastEvents": false
}

Responses​

Event objects.

application/json
JSON
{
  
"success": true,
  
"events": [
  
  
{
  
  
  
"id": 1,
  
  
  
"createdAt": "2020-01-29T18:10:16.630Z",
  
  
  
"updatedAt": "2020-01-30T22:42:14.789Z",
  
  
  
"title": "Event title",
  
  
  
"status": "EventScheduled",
  
  
  
"slug": "event-slug",
  
  
  
"start_datetime": 1784109600,
  
  
  
"end_datetime": 1784131200,
  
  
  
"media": [
  
  
  
  
{
  
  
  
  
  
"name": "Image name",
  
  
  
  
  
"url": "6e599b27-5ed8-44c9-b954-53e9c6fa3c80.jpg",
  
  
  
  
  
"height": 400,
  
  
  
  
  
"width": 200,
  
  
  
  
  
"size": 50000,
  
  
  
  
  
"focalpoint": [
  
  
  
  
  
  
[
  
  
  
  
  
  
  
0,
  
  
  
  
  
  
  
0
  
  
  
  
  
  
]
  
  
  
  
  
]
  
  
  
  
}
  
  
  
],
  
  
  
"description": "Event description",
  
  
  
"is_visible": true,
  
  
  
"online_locations": [
  
  
  
  
[
  
  
  
  
  
"https://event.online",
  
  
  
  
  
"https://eventalt.online"
  
  
  
  
]
  
  
  
],
  
  
  
"recurrent": {
  
  
  
  
"frequency": "1w",
  
  
  
  
"type": "ordinal"
  
  
  
},
  
  
  
"ld_signature": {
  
  
  
  
"@context": "https://w3id.org/identity/v1",
  
  
  
  
"creator": "http://localhost:13120/federation/u/relay#main-key",
  
  
  
  
"created": "2026-07-01T21:07:49.103Z",
  
  
  
  
"signatureValue": "SIGNATURE_KEY"
  
  
  
},
  
  
  
"ap_object": {
  
  
  
},
  
  
  
"likes": [
  
  
  
  
{
  
  
  
  
}
  
  
  
],
  
  
  
"boost": [
  
  
  
  
{
  
  
  
  
}
  
  
  
],
  
  
  
"ap_id": "AP_ID",
  
  
  
"userId": 3,
  
  
  
"user": {
  
  
  
  
"id": 1,
  
  
  
  
"email": "example@gancio.org",
  
  
  
  
"description": "Example user",
  
  
  
  
"is_active": true,
  
  
  
  
"to_notify": true,
  
  
  
  
"role": "user",
  
  
  
  
"createdAt": "2020-01-29T18:10:16.630Z",
  
  
  
  
"updatedAt": "2020-01-30T22:42:14.789Z"
  
  
  
},
  
  
  
"parentId": 23,
  
  
  
"parent": "[Circular Reference]",
  
  
  
"children": [
  
  
  
  
{
  
  
  
  
}
  
  
  
],
  
  
  
"placeId": 23,
  
  
  
"place": {
  
  
  
  
"id": 20,
  
  
  
  
"name": "Location name",
  
  
  
  
"address": "Address",
  
  
  
  
"ap_id": "AP_ID",
  
  
  
  
"postal_address": {
  
  
  
  
},
  
  
  
  
"latitude": 40.5574,
  
  
  
  
"longitude": 8.3263,
  
  
  
  
"createdAt": "2020-01-29T18:10:16.630Z",
  
  
  
  
"updatedAt": "2020-01-30T22:42:14.789Z"
  
  
  
},
  
  
  
"tags": [
  
  
  
  
{
  
  
  
  
  
"tag": "event_tag",
  
  
  
  
  
"normalizedTag": "event_tag",
  
  
  
  
  
"events": [
  
  
  
  
  
  
{
  
  
  
  
  
  
}
  
  
  
  
  
]
  
  
  
  
}
  
  
  
],
  
  
  
"apUserApId": "AP_USER_ID",
  
  
  
"apUser": "[Circular Reference]",
  
  
  
"messages": [
  
  
  
  
{
  
  
  
  
  
"id": 12,
  
  
  
  
  
"message": "A message for an event.",
  
  
  
  
  
"author": "AUTHOR",
  
  
  
  
  
"is_author_visible": true,
  
  
  
  
  
"eventId": 3,
  
  
  
  
  
"createdAt": "2020-01-29T18:10:16.630Z",
  
  
  
  
  
"updatedAt": "2020-01-30T22:42:14.789Z"
  
  
  
  
}
  
  
  
],
  
  
  
"resources": [
  
  
  
  
{
  
  
  
  
}
  
  
  
]
  
  
}
  
]
}

Playground​

Body

Samples​

Powered by VitePress OpenAPI