delete /comment/{cid}patch /comment/{cid}post /commentget /piipe_comments/{cid}get /piipe_comments/listpost /piipe_comments/mediapost /piipe_comments/mentionget /piipe_comments/thread-trace/{cid}delete /community/{gid}get /community/{gid}patch /community/joining_request/{gid}post /community/joining_requestget /community/listget /community/members/{gid}patch /community/members/{gid}post /communityget /community/settings/{gid}patch /community/settings/{gid}get /community/settings/{gid}/userpatch /community/settings/{gid}/userget /birthday_calendar_filtersget /box_pages/frontend/boxes/reorderpatch /box_pages/frontend/boxes/reorderpatch /box_pages/my_page_addget /bulletin/configget /employee_directory/configget /scssadminget /box/{bid}/{view_mode}get /node/{nid}/{view_mode}post /piipe_flags/flagpatch /pollget /social_icons/{nid}get /menu/{menu_name}get /piipe_toolbar/configget /piipe_toolbar/custom_objectspatch /piipe_toolbar/custom_objectspost /piipe_toolbar/custom_objectsget /piipe_toolbar/settingspatch /piipe_toolbar/settingspost /piipe_toolbar/settingsget /notificationspatch /notificationspost /register_device_tokendelete /register_device_token/{token}post /api/v1/piipe_picture_gallery/createget /birthday_calendarget /birthday_calendar/recent_birthday/{type}get /box_pages/{page_name}get /document_searchget /employee_directory/employeesget /employee_jubileespost /event/bookmarkdelete /event/{nid}/registrationsget /event/{nid}/registrations/downloadget /event/{nid}/registrationspost /event/{nid}/registrationsget /event/{type}get /eventsget /magazine_topic/{topic}get /new_colleaguesget /news_menuget /news/{news_page}get /piipe_picture_gallerypatch /piipe_picture_galleryget /room_searchget /searchget /tags/{page}get /taxonomy_page/{tid}get /vehicle_searchget /videosget /wiki_overviewget /wiki_term_overview/{term_id}post /openid_connect_login/{oidc_client_name}get /refresh_tokenpost /user/code_registerget /user-login-checkpost /user-loginpost /user-login/tfapost /user-logoutpost /user/logoutget /user_profile/edit/{uid}patch /user_profile/edit/{uid}get /user_profile/{uid}post /user/registerget /user_sessionget /user_settingspatch /user_settingsdelete /comment/{cid}patch /comment/{cid}Edit a comment.
To like/unlike a comment, use the endpoint /piipe_flags/flag and pass the following body:
{"flag_id": "comments_like", "entity_type": "comment", "entity_id": CID, "action": "flag"}
Where CID is the comment ID, action can be either "flag" or "unflag" and entity_type can be either "comment" or "discussion_comments".
To report a comment, use the same body as above with "flag_id": "comment_report" (example: {"flag_id": "comment_report", "entity_type": "comment", "entity_id": CID, "action": "flag"}).
application/json{
"created" : "01.01.2025",
"subject" : "My comment",
"author" : {
"uid" : 100,
"name" : "John Doe",
"picture" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
}
},
"flags" : {
"like" : {
"flagged" : true,
"count" : 3
},
"report" : {
"flagged" : true,
"count" : 2,
"flagged_by_current_user" : false
}
},
"answers" : [ null, null ],
"pid" : "42",
"answerCount" : 4,
"addressee" : "public",
"isCommentOwner" : true,
"permissions" : {
"edit" : true,
"report" : true,
"delete" : false
},
"fields" : {
"comment_body" : {
"format" : "comment_editor",
"value" : "This is a comment"
},
"subject" : {
"value" : "My comment"
}
},
"cid" : 123,
"changed" : "01.01.2025"
}application/jsonpost /commentapplication/json{
"created" : "01.01.2025",
"subject" : "My comment",
"author" : {
"uid" : 100,
"name" : "John Doe",
"picture" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
}
},
"flags" : {
"like" : {
"flagged" : true,
"count" : 3
},
"report" : {
"flagged" : true,
"count" : 2,
"flagged_by_current_user" : false
}
},
"answers" : [ null, null ],
"pid" : "42",
"answerCount" : 4,
"addressee" : "public",
"isCommentOwner" : true,
"permissions" : {
"edit" : true,
"report" : true,
"delete" : false
},
"fields" : {
"comment_body" : {
"format" : "comment_editor",
"value" : "This is a comment"
},
"subject" : {
"value" : "My comment"
}
},
"cid" : 123,
"changed" : "01.01.2025"
}application/jsonget /piipe_comments/{cid}{
"created" : "01.01.2025",
"subject" : "My comment",
"author" : {
"uid" : 100,
"name" : "John Doe",
"picture" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
}
},
"flags" : {
"like" : {
"flagged" : true,
"count" : 3
},
"report" : {
"flagged" : true,
"count" : 2,
"flagged_by_current_user" : false
}
},
"answers" : [ null, null ],
"pid" : "42",
"answerCount" : 4,
"addressee" : "public",
"isCommentOwner" : true,
"permissions" : {
"edit" : true,
"report" : true,
"delete" : false
},
"fields" : {
"comment_body" : {
"format" : "comment_editor",
"value" : "This is a comment"
},
"subject" : {
"value" : "My comment"
}
},
"cid" : 123,
"changed" : "01.01.2025"
}application/jsonget /piipe_comments/list{
"comments" : [ {
"created" : "01.01.2025",
"subject" : "My comment",
"author" : {
"uid" : 100,
"name" : "John Doe",
"picture" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
}
},
"flags" : {
"like" : {
"flagged" : true,
"count" : 3
},
"report" : {
"flagged" : true,
"count" : 2,
"flagged_by_current_user" : false
}
},
"answers" : [ null, null ],
"pid" : "42",
"answerCount" : 4,
"addressee" : "public",
"isCommentOwner" : true,
"permissions" : {
"edit" : true,
"report" : true,
"delete" : false
},
"fields" : {
"comment_body" : {
"format" : "comment_editor",
"value" : "This is a comment"
},
"subject" : {
"value" : "My comment"
}
},
"cid" : 123,
"changed" : "01.01.2025"
}, {
"created" : "01.01.2025",
"subject" : "My comment",
"author" : {
"uid" : 100,
"name" : "John Doe",
"picture" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
}
},
"flags" : {
"like" : {
"flagged" : true,
"count" : 3
},
"report" : {
"flagged" : true,
"count" : 2,
"flagged_by_current_user" : false
}
},
"answers" : [ null, null ],
"pid" : "42",
"answerCount" : 4,
"addressee" : "public",
"isCommentOwner" : true,
"permissions" : {
"edit" : true,
"report" : true,
"delete" : false
},
"fields" : {
"comment_body" : {
"format" : "comment_editor",
"value" : "This is a comment"
},
"subject" : {
"value" : "My comment"
}
},
"cid" : 123,
"changed" : "01.01.2025"
} ],
"nextAnswers" : [ {
"created" : "01.01.2025",
"subject" : "My comment",
"author" : {
"uid" : 100,
"name" : "John Doe",
"picture" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
}
},
"flags" : {
"like" : {
"flagged" : true,
"count" : 3
},
"report" : {
"flagged" : true,
"count" : 2,
"flagged_by_current_user" : false
}
},
"answers" : [ null, null ],
"pid" : "42",
"answerCount" : 4,
"addressee" : "public",
"isCommentOwner" : true,
"permissions" : {
"edit" : true,
"report" : true,
"delete" : false
},
"fields" : {
"comment_body" : {
"format" : "comment_editor",
"value" : "This is a comment"
},
"subject" : {
"value" : "My comment"
}
},
"cid" : 123,
"changed" : "01.01.2025"
}, {
"created" : "01.01.2025",
"subject" : "My comment",
"author" : {
"uid" : 100,
"name" : "John Doe",
"picture" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
}
},
"flags" : {
"like" : {
"flagged" : true,
"count" : 3
},
"report" : {
"flagged" : true,
"count" : 2,
"flagged_by_current_user" : false
}
},
"answers" : [ null, null ],
"pid" : "42",
"answerCount" : 4,
"addressee" : "public",
"isCommentOwner" : true,
"permissions" : {
"edit" : true,
"report" : true,
"delete" : false
},
"fields" : {
"comment_body" : {
"format" : "comment_editor",
"value" : "This is a comment"
},
"subject" : {
"value" : "My comment"
}
},
"cid" : 123,
"changed" : "01.01.2025"
} ],
"count" : 10,
"thread_permission" : true,
"title" : "Community Discussion",
"comment_status" : 2,
"administrators" : [ {
"name" : "John Doe",
"url" : "user/10"
}, {
"name" : "John Doe",
"url" : "user/10"
} ],
"changed" : "01.01.2025"
}application/jsonpost /piipe_comments/mediaapplication/json{
"is_last" : false
}application/jsonpost /piipe_comments/mentionapplication/json[ {
"name" : "John",
"link" : "/user/42",
"id" : "@John",
"userId" : [ {
"value" : 42
}, {
"value" : 42
} ]
}, {
"name" : "John",
"link" : "/user/42",
"id" : "@John",
"userId" : [ {
"value" : 42
}, {
"value" : 42
} ]
} ]application/jsonget /piipe_comments/thread-trace/{cid}{
"threads" : {
"created" : "01.01.2025",
"subject" : "My comment",
"author" : {
"uid" : 100,
"name" : "John Doe",
"picture" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
}
},
"flags" : {
"like" : {
"flagged" : true,
"count" : 3
},
"report" : {
"flagged" : true,
"count" : 2,
"flagged_by_current_user" : false
}
},
"answers" : [ null, null ],
"pid" : "42",
"answerCount" : 4,
"addressee" : "public",
"isCommentOwner" : true,
"permissions" : {
"edit" : true,
"report" : true,
"delete" : false
},
"fields" : {
"comment_body" : {
"format" : "comment_editor",
"value" : "This is a comment"
},
"subject" : {
"value" : "My comment"
}
},
"cid" : 123,
"changed" : "01.01.2025"
},
"cids" : {
"1" : [ 2, 3 ]
}
}application/jsondelete /community/{gid}get /community/{gid}{
"thumbnail" : "/system/files/styles/media_library/private/medialibrary/image.jpg",
"creator" : "John Doe",
"community_visibility" : 0,
"created" : "01.01.2025",
"description" : "This is community description.",
"rules" : "Some rules.",
"members_count" : 10,
"title" : "HR",
"did" : "12",
"admins" : {
"key" : {
"thumbnail" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"name" : "John Doe"
}
}
}application/jsonpatch /community/joining_request/{gid}application/jsonapplication/jsonpost /community/joining_requestapplication/jsonapplication/jsonget /community/list{
"communities" : [ {
"thumbnail" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"gid" : 0,
"visibility" : 6,
"is_member" : true,
"is_last_admin" : true,
"edit_access" : true,
"members" : 1,
"join_request" : true,
"description" : "description",
"title" : "HR"
}, {
"thumbnail" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"gid" : 0,
"visibility" : 6,
"is_member" : true,
"is_last_admin" : true,
"edit_access" : true,
"members" : 1,
"join_request" : true,
"description" : "description",
"title" : "HR"
} ]
}application/jsonget /community/members/{gid}{
"members" : [ {
"uid" : 0,
"memberSince" : "05/02/2024",
"thumbnail" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"mail" : "someone@example.com",
"communityRoleId" : "community_member",
"name" : "Clara",
"communityRole" : "Member"
}, {
"uid" : 0,
"memberSince" : "05/02/2024",
"thumbnail" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"mail" : "someone@example.com",
"communityRoleId" : "community_member",
"name" : "Clara",
"communityRole" : "Member"
} ],
"adminCount" : 1,
"count" : 10
}application/jsonpatch /community/members/{gid}application/jsonapplication/jsonpost /communityapplication/jsonget /community/settings/{gid}{
"gid" : {
"label" : "ID",
"type" : "integer",
"required" : false,
"value" : 14
},
"uuid" : {
"label" : "UUID",
"type" : "uuid",
"required" : false,
"value" : "a94b5d1f-1f04-40ee-8129-f5de192937d8"
},
"langcode" : {
"label" : "Sprache",
"type" : "language",
"required" : false,
"value" : "en"
},
"uid" : {
"label" : "Created by",
"type" : "entity_reference",
"required" : false,
"value" : [ {
"target_id" : 112,
"target_type" : "user",
"target_uuid" : "acddabfb-91a3-4c01-af18-bf977c88a77e",
"url" : "/user/112"
} ]
},
"title" : {
"label" : "Titel",
"type" : "string",
"required" : true,
"value" : "HR"
},
"type" : {
"label" : "Typ",
"type" : "string",
"required" : false,
"value" : null
},
"created" : {
"label" : "Created",
"type" : "created",
"required" : false,
"value" : "30.04.2024"
},
"changed" : {
"label" : "Geändert",
"type" : "changed",
"required" : false,
"value" : "30.04.2024"
},
"default_langcode" : {
"label" : "Standardsprache",
"type" : "boolean",
"required" : false,
"value" : true
},
"path" : {
"label" : "Pfad",
"type" : "path",
"required" : false,
"value" : {
"alias" : "/hr",
"pid" : 99,
"langcode" : "en"
}
},
"status" : {
"label" : "Status",
"type" : "boolean",
"required" : false,
"value" : true
},
"public" : {
"label" : "Öffentlich",
"type" : "boolean",
"required" : false,
"value" : true
},
"description" : {
"label" : "Beschreibung",
"type" : "string",
"required" : false,
"value" : "Human Resources Group"
},
"members" : {
"label" : "Mitglieder",
"type" : "entity_reference",
"required" : false,
"value" : [ {
"target_id" : 21,
"target_type" : "community_member",
"target_uuid" : "66a575fb-9dce-4f79-826a-ed80eb5bc20b",
"url" : "/community_member/21?community=14&group=14"
}, {
"target_id" : 25,
"target_type" : "community_member",
"target_uuid" : "dc186a71-4dea-4991-9bf3-4705f239790c",
"url" : "/community_member/25?community=14&group=14"
} ]
},
"community_picture" : {
"label" : "Picture",
"type" : "image",
"required" : false,
"default" : {
"url" : "/themes/contrib/piipe_backend/images/icons/media/picture-placeholder.svg",
"alt" : "Default picture for community HR"
},
"value" : {
"url" : "/system/files/styles/thumbnail/private/community/14/community-picture/hr.webp?h=abc&itok=def",
"alt" : "Picture for community HR"
}
},
"joining_requests" : {
"label" : "Beitrittsanfragen",
"type" : "entity_reference",
"required" : false,
"value" : [ ]
}
}application/jsonpatch /community/settings/{gid}application/json{
"gid" : {
"label" : "ID",
"type" : "integer",
"required" : false,
"value" : 14
},
"uuid" : {
"label" : "UUID",
"type" : "uuid",
"required" : false,
"value" : "a94b5d1f-1f04-40ee-8129-f5de192937d8"
},
"langcode" : {
"label" : "Sprache",
"type" : "language",
"required" : false,
"value" : "en"
},
"uid" : {
"label" : "Created by",
"type" : "entity_reference",
"required" : false,
"value" : [ {
"target_id" : 112,
"target_type" : "user",
"target_uuid" : "acddabfb-91a3-4c01-af18-bf977c88a77e",
"url" : "/user/112"
} ]
},
"title" : {
"label" : "Titel",
"type" : "string",
"required" : true,
"value" : "HR"
},
"type" : {
"label" : "Typ",
"type" : "string",
"required" : false,
"value" : null
},
"created" : {
"label" : "Created",
"type" : "created",
"required" : false,
"value" : "30.04.2024"
},
"changed" : {
"label" : "Geändert",
"type" : "changed",
"required" : false,
"value" : "30.04.2024"
},
"default_langcode" : {
"label" : "Standardsprache",
"type" : "boolean",
"required" : false,
"value" : true
},
"path" : {
"label" : "Pfad",
"type" : "path",
"required" : false,
"value" : {
"alias" : "/hr",
"pid" : 99,
"langcode" : "en"
}
},
"status" : {
"label" : "Status",
"type" : "boolean",
"required" : false,
"value" : true
},
"public" : {
"label" : "Öffentlich",
"type" : "boolean",
"required" : false,
"value" : true
},
"description" : {
"label" : "Beschreibung",
"type" : "string",
"required" : false,
"value" : "Human Resources Group"
},
"members" : {
"label" : "Mitglieder",
"type" : "entity_reference",
"required" : false,
"value" : [ {
"target_id" : 21,
"target_type" : "community_member",
"target_uuid" : "66a575fb-9dce-4f79-826a-ed80eb5bc20b",
"url" : "/community_member/21?community=14&group=14"
}, {
"target_id" : 25,
"target_type" : "community_member",
"target_uuid" : "dc186a71-4dea-4991-9bf3-4705f239790c",
"url" : "/community_member/25?community=14&group=14"
} ]
},
"community_picture" : {
"label" : "Picture",
"type" : "image",
"required" : false,
"default" : {
"url" : "/themes/contrib/piipe_backend/images/icons/media/picture-placeholder.svg",
"alt" : "Default picture for community HR"
},
"value" : {
"url" : "/system/files/styles/thumbnail/private/community/14/community-picture/hr.webp?h=abc&itok=def",
"alt" : "Picture for community HR"
}
},
"joining_requests" : {
"label" : "Beitrittsanfragen",
"type" : "entity_reference",
"required" : false,
"value" : [ ]
}
}application/jsonget /community/settings/{gid}/user{
"community_notifications" : [ {
"system" : true,
"mail" : true,
"id" : 0,
"label" : "label",
"mandatory" : true,
"push" : true
}, {
"system" : true,
"mail" : true,
"id" : 0,
"label" : "label",
"mandatory" : true,
"push" : true
} ]
}application/jsonpatch /community/settings/{gid}/userapplication/json{
"community_notifications" : [ {
"system" : true,
"mail" : true,
"id" : 0,
"label" : "label",
"mandatory" : true,
"push" : true
}, {
"system" : true,
"mail" : true,
"id" : 0,
"label" : "label",
"mandatory" : true,
"push" : true
} ]
}application/jsonget /birthday_calendar_filters{
"location_filter" : [ {
"name" : "Berlin",
"id" : 0
}, {
"name" : "Berlin",
"id" : 0
} ]
}application/jsonget /box_pages/frontend/boxes/reorder[ {
"author" : "John Doe",
"weight" : 6,
"bid" : 0,
"title" : "Accessibility",
"type" : "Content box",
"changed" : "12/04/2023"
}, {
"author" : "John Doe",
"weight" : 6,
"bid" : 0,
"title" : "Accessibility",
"type" : "Content box",
"changed" : "12/04/2023"
} ]application/jsonpatch /box_pages/frontend/boxes/reorderapplication/jsonpatch /box_pages/my_page_addapplication/json{
"text" : "Add to my page",
"status" : true
}application/jsonget /bulletin/config[ {
"types" : [ {
"id" : "offer",
"name" : "Offer"
}, {
"id" : "search",
"name" : "Search"
} ],
"consent_text" : "It is confirmed that for the media posted on the intranet, the regulations on rights of use have been taken into account in accordance with the Terms of Use and Privacy Policy.",
"breadcrumbRoots" : [ {
"text" : "Services",
"route" : "/services"
} ],
"permissions" : [ {
"create" : true
} ],
"language" : "en",
"categories" : [ {
"id" : "267",
"name" : "Cars, Motorbikes"
}, {
"id" : "272",
"name" : "Clothing"
}, {
"id" : "271",
"name" : "Hobby"
} ]
}, {
"types" : [ {
"id" : "offer",
"name" : "Offer"
}, {
"id" : "search",
"name" : "Search"
} ],
"consent_text" : "It is confirmed that for the media posted on the intranet, the regulations on rights of use have been taken into account in accordance with the Terms of Use and Privacy Policy.",
"breadcrumbRoots" : [ {
"text" : "Services",
"route" : "/services"
} ],
"permissions" : [ {
"create" : true
} ],
"language" : "en",
"categories" : [ {
"id" : "267",
"name" : "Cars, Motorbikes"
}, {
"id" : "272",
"name" : "Clothing"
}, {
"id" : "271",
"name" : "Hobby"
} ]
} ]application/jsonget /employee_directory/config[ {
"uid" : 1,
"alphabet_counted" : {
"A" : 3,
"B" : 1,
"C" : 1,
"D" : 1,
"E" : 0
},
"columns" : [ {
"filter" : [ ],
"frontend_label" : "",
"field_label" : "Position",
"name" : "field_position",
"weight" : 0,
"type" : "text",
"delete" : "Löschen"
}, {
"filter" : [ ],
"frontend_label" : "",
"field_label" : "Position",
"name" : "field_position",
"weight" : 0,
"type" : "text",
"delete" : "Löschen"
} ],
"language" : "en",
"dropdowns" : [ {
"field_location" : [ {
"tid" : 48,
"label" : "Berlin"
}, {
"tid" : 211,
"label" : "München"
}, {
"tid" : 277,
"label" : "Paris"
}, {
"tid" : 361,
"label" : "Rosenberg"
}, {
"tid" : 47,
"label" : "Saarbrücken"
}, {
"tid" : 278,
"label" : "Trier"
} ]
}, {
"field_location" : [ {
"tid" : 48,
"label" : "Berlin"
}, {
"tid" : 211,
"label" : "München"
}, {
"tid" : 277,
"label" : "Paris"
}, {
"tid" : 361,
"label" : "Rosenberg"
}, {
"tid" : 47,
"label" : "Saarbrücken"
}, {
"tid" : 278,
"label" : "Trier"
} ]
} ],
"hierarchical_sorting" : [ {
"click_field" : "field_organizational_unit",
"sorting_field" : "field_team_leader"
}, {
"click_field" : "field_organizational_unit",
"sorting_field" : "field_team_leader"
} ]
}, {
"uid" : 1,
"alphabet_counted" : {
"A" : 3,
"B" : 1,
"C" : 1,
"D" : 1,
"E" : 0
},
"columns" : [ {
"filter" : [ ],
"frontend_label" : "",
"field_label" : "Position",
"name" : "field_position",
"weight" : 0,
"type" : "text",
"delete" : "Löschen"
}, {
"filter" : [ ],
"frontend_label" : "",
"field_label" : "Position",
"name" : "field_position",
"weight" : 0,
"type" : "text",
"delete" : "Löschen"
} ],
"language" : "en",
"dropdowns" : [ {
"field_location" : [ {
"tid" : 48,
"label" : "Berlin"
}, {
"tid" : 211,
"label" : "München"
}, {
"tid" : 277,
"label" : "Paris"
}, {
"tid" : 361,
"label" : "Rosenberg"
}, {
"tid" : 47,
"label" : "Saarbrücken"
}, {
"tid" : 278,
"label" : "Trier"
} ]
}, {
"field_location" : [ {
"tid" : 48,
"label" : "Berlin"
}, {
"tid" : 211,
"label" : "München"
}, {
"tid" : 277,
"label" : "Paris"
}, {
"tid" : 361,
"label" : "Rosenberg"
}, {
"tid" : 47,
"label" : "Saarbrücken"
}, {
"tid" : 278,
"label" : "Trier"
} ]
} ],
"hierarchical_sorting" : [ {
"click_field" : "field_organizational_unit",
"sorting_field" : "field_team_leader"
}, {
"click_field" : "field_organizational_unit",
"sorting_field" : "field_team_leader"
} ]
} ]application/jsonget /scssadminapplication/jsonget /box/{bid}/{view_mode}{
"entity_type" : "box",
"box_type" : "content_box",
"id" : 0,
"content" : {
"summary" : "In the video series 'ChatGPT - briefly explained', Aljoscha Burchardt from the German Research Center for Artificial Intelligence (DFKI) explains the technology behind the AI chatbot and discusses its influence on various aspects of our lives.",
"entity_type" : "node",
"node_type" : "content_page",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
}
}application/jsonget /node/{nid}/{view_mode}{
"summary" : "In the video series 'ChatGPT - briefly explained', Aljoscha Burchardt from the German Research Center for Artificial Intelligence (DFKI) explains the technology behind the AI chatbot and discusses its influence on various aspects of our lives.",
"entity_type" : "node",
"node_type" : "content_page",
"authored_by" : {
"id" : 0,
"text" : "text",
"user_text" : "user_text"
},
"my_page_button" : {
"active" : true,
"id" : 6,
"text" : "Add to my page",
"status" : true
},
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"content" : [ {
"block_name" : "core/paragraph",
"inner_blocks" : [ ],
"html" : "html"
}, {
"block_name" : "core/paragraph",
"inner_blocks" : [ ],
"html" : "html"
} ],
"kicker" : "AI & digitization",
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
}application/jsonpost /piipe_flags/flagapplication/json{
"flag_id" : "content_flag_like",
"entity_type" : "node",
"flagged" : true,
"count" : 50,
"entity_id" : 1
}application/jsonpatch /pollapplication/json{
"total_votes" : 4,
"question" : "Which ice cream flavor do you like best?",
"cancel_vote_allow" : false,
"voted" : false,
"id" : 0,
"choices" : [ {
"vote_percentage" : 50,
"id" : 6,
"text" : "Chocolate",
"vote_count" : 2
}, {
"vote_percentage" : 50,
"id" : 6,
"text" : "Chocolate",
"vote_count" : 2
} ]
}application/jsonget /social_icons/{nid}{
"comments" : {
"count" : 10
},
"rocks" : {
"flag_id" : "content_flag_rocks",
"entity_type" : "node",
"flagged" : true,
"count" : 50,
"entity_id" : 1
},
"like" : {
"flag_id" : "content_flag_like",
"entity_type" : "node",
"flagged" : true,
"count" : 50,
"entity_id" : 1
},
"heart" : {
"flag_id" : "content_flag_heart",
"entity_type" : "node",
"flagged" : true,
"count" : 50,
"entity_id" : 1
},
"views" : {
"count" : 100
}
}application/jsonget /frontpage[ {
"components" : [ {
"type" : "frontpage_slider",
"uuid" : "wy64mm78-m4ks-nrk4-z5mm-cjrfvb9iqnfq"
}, {
"type" : "frontpage_slider",
"uuid" : "wy64mm78-m4ks-nrk4-z5mm-cjrfvb9iqnfq"
} ],
"background_color" : "#fffff",
"title" : "News"
}, {
"components" : [ {
"type" : "frontpage_slider",
"uuid" : "wy64mm78-m4ks-nrk4-z5mm-cjrfvb9iqnfq"
}, {
"type" : "frontpage_slider",
"uuid" : "wy64mm78-m4ks-nrk4-z5mm-cjrfvb9iqnfq"
} ],
"background_color" : "#fffff",
"title" : "News"
} ]application/jsonget /frontpage/{uuid}sub_facets of a magazine_category_filter_box component to restrict search_results to that channel. default: null {
"additional_data" : {
"additional_data_2" : "Concrete_Component_additional_data_additional_data_2",
"additional_data_1" : "Concrete_Component_additional_data_additional_data_1"
},
"data" : [ {
"summary" : "In the video series 'ChatGPT - briefly explained', Aljoscha Burchardt from the German Research Center for Artificial Intelligence (DFKI) explains the technology behind the AI chatbot and discusses its influence on various aspects of our lives.",
"entity_type" : "node",
"node_type" : "content_page",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"kicker" : "AI & digitization",
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
}, {
"summary" : "In the video series 'ChatGPT - briefly explained', Aljoscha Burchardt from the German Research Center for Artificial Intelligence (DFKI) explains the technology behind the AI chatbot and discusses its influence on various aspects of our lives.",
"entity_type" : "node",
"node_type" : "content_page",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"kicker" : "AI & digitization",
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
} ],
"type" : "frontpage_slider",
"title" : "Frontpage Slider",
"empty" : {
"text" : "There is currently no news to display."
}
}application/jsonget /magazine[ {
"components" : [ {
"type" : "frontpage_slider",
"uuid" : "wy64mm78-m4ks-nrk4-z5mm-cjrfvb9iqnfq"
}, {
"type" : "frontpage_slider",
"uuid" : "wy64mm78-m4ks-nrk4-z5mm-cjrfvb9iqnfq"
} ],
"background_color" : "#fffff",
"title" : "News"
}, {
"components" : [ {
"type" : "frontpage_slider",
"uuid" : "wy64mm78-m4ks-nrk4-z5mm-cjrfvb9iqnfq"
}, {
"type" : "frontpage_slider",
"uuid" : "wy64mm78-m4ks-nrk4-z5mm-cjrfvb9iqnfq"
} ],
"background_color" : "#fffff",
"title" : "News"
} ]application/jsonget /magazine/{uuid}sub_facets of a magazine_category_filter_box component to restrict search_results to that channel. default: null {
"additional_data" : {
"additional_data_2" : "Concrete_Component_additional_data_additional_data_2",
"additional_data_1" : "Concrete_Component_additional_data_additional_data_1"
},
"data" : [ {
"summary" : "In the video series 'ChatGPT - briefly explained', Aljoscha Burchardt from the German Research Center for Artificial Intelligence (DFKI) explains the technology behind the AI chatbot and discusses its influence on various aspects of our lives.",
"entity_type" : "node",
"node_type" : "content_page",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"kicker" : "AI & digitization",
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
}, {
"summary" : "In the video series 'ChatGPT - briefly explained', Aljoscha Burchardt from the German Research Center for Artificial Intelligence (DFKI) explains the technology behind the AI chatbot and discusses its influence on various aspects of our lives.",
"entity_type" : "node",
"node_type" : "content_page",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"kicker" : "AI & digitization",
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
} ],
"type" : "frontpage_slider",
"title" : "Frontpage Slider",
"empty" : {
"text" : "There is currently no news to display."
}
}application/jsonget /menu/{menu_name}[ {
"link_type" : "external",
"subtree" : [ ],
"route_name" : "box_pages.services",
"link" : "link",
"title" : "Profile",
"icon_id" : "fa-facebook"
}, {
"link_type" : "external",
"subtree" : [ ],
"route_name" : "box_pages.services",
"link" : "link",
"title" : "Profile",
"icon_id" : "fa-facebook"
} ]application/jsonget /piipe_toolbar/configapplication/jsonget /piipe_toolbar/custom_objectsapplication/jsonpatch /piipe_toolbar/custom_objectsapplication/jsonpost /piipe_toolbar/custom_objectsapplication/jsonget /piipe_toolbar/settingsapplication/jsonpatch /piipe_toolbar/settingsapplication/jsonpost /piipe_toolbar/settingsapplication/jsonget /notifications{
"unread_count" : 1,
"messages" : [ {
"additional_data" : {
"route_1" : "entity.node.canonical",
"route_2" : "entity.node.canonical",
"notification_type" : "social_reaction",
"node_id" : "123",
"user_id" : "45",
"comment_id" : "678",
"commented_entity_type" : "node",
"commented_entity_id" : "123",
"linked_entity_id" : "123"
},
"referenced_entity_id" : 6,
"image_url" : "image_url",
"mid" : 0,
"description" : "description",
"time" : "time",
"text" : "text",
"type" : "content_creation",
"referenced_entity_type" : "node",
"status" : true,
"info" : "info"
}, {
"additional_data" : {
"route_1" : "entity.node.canonical",
"route_2" : "entity.node.canonical",
"notification_type" : "social_reaction",
"node_id" : "123",
"user_id" : "45",
"comment_id" : "678",
"commented_entity_type" : "node",
"commented_entity_id" : "123",
"linked_entity_id" : "123"
},
"referenced_entity_id" : 6,
"image_url" : "image_url",
"mid" : 0,
"description" : "description",
"time" : "time",
"text" : "text",
"type" : "content_creation",
"referenced_entity_type" : "node",
"status" : true,
"info" : "info"
} ]
}application/jsonpatch /notificationsapplication/jsonpost /register_device_tokenapplication/json"The requested device token is already registered. User, creation time and language associated with that device token have been updated.""Device token was successfully registered."{
"message" : "Attribute 'token' is missing."
}application/jsondelete /register_device_token/{token}{
"message" : "You are not allowed to delete this device token."
}{
"message" : "The requested device token cannot be found."
}application/jsonpost /api/v1/piipe_picture_gallery/createapplication/json{
"item" : {
"date" : "1739461059",
"flag" : {
"like_count" : "2",
"rock_flagged" : false,
"rock_count" : "1",
"heart_count" : "2",
"heart_flagged" : true,
"like_flagged" : true
},
"hashtags" : [ {
"name" : "relatable",
"id" : "496"
}, {
"name" : "relatable",
"id" : "496"
} ],
"author" : {
"langcode" : "Germany",
"name" : "John Doe",
"picture" : {
"alt" : "Profile picture for user John Doe",
"url" : "/system/files/styles/thumbnail/private/medialibrary/profile_image.jpg?h=cc71e594&itok=yAsmmMts"
}
},
"permissions" : {
"edit" : true,
"delete" : true
},
"description" : "This is a description text.",
"id" : "1",
"title" : "This is a post title",
"url" : "/system/files/styles/picture_gallery/private/picture_gallery/pexels-diiefao-2258357.jpg?itok=LVC9QA64"
},
"is_last" : true
}application/jsonget /birthday_calendar{
"DATE_1" : [ {
"field_position_value" : "Developer",
"user_picture" : "https://example.com/image.jpg",
"field_location_value" : "Berlin",
"field_birthday_value" : "04. Februar",
"name" : "John Doe",
"user_profile_link" : "/user/1",
"entity_id" : 0
}, {
"field_position_value" : "Developer",
"user_picture" : "https://example.com/image.jpg",
"field_location_value" : "Berlin",
"field_birthday_value" : "04. Februar",
"name" : "John Doe",
"user_profile_link" : "/user/1",
"entity_id" : 0
} ],
"DATE_2" : [ {
"field_position_value" : "Developer",
"user_picture" : "https://example.com/image.jpg",
"field_location_value" : "Berlin",
"field_birthday_value" : "04. Februar",
"name" : "John Doe",
"user_profile_link" : "/user/1",
"entity_id" : 0
}, {
"field_position_value" : "Developer",
"user_picture" : "https://example.com/image.jpg",
"field_location_value" : "Berlin",
"field_birthday_value" : "04. Februar",
"name" : "John Doe",
"user_profile_link" : "/user/1",
"entity_id" : 0
} ]
}application/jsonget /birthday_calendar/recent_birthday/{type}[ {
"birthday" : "1995-04-15",
"field_position_value" : "Developer",
"user_picture" : "https://example.com/image.jpg",
"name" : "John Doe",
"user_profile_link" : "/user/1",
"id" : 0
}, {
"birthday" : "1995-04-15",
"field_position_value" : "Developer",
"user_picture" : "https://example.com/image.jpg",
"name" : "John Doe",
"user_profile_link" : "/user/1",
"id" : 0
} ]application/jsonget /box_pages/{page_name}{
"page_type" : "static",
"page_title" : "Company",
"uncategorized" : [ {
"boxes" : [ {
"entity_type" : "box",
"box_type" : "content_box",
"id" : 0,
"content" : {
"summary" : "In the video series 'ChatGPT - briefly explained', Aljoscha Burchardt from the German Research Center for Artificial Intelligence (DFKI) explains the technology behind the AI chatbot and discusses its influence on various aspects of our lives.",
"entity_type" : "node",
"node_type" : "content_page",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
}
}, {
"entity_type" : "box",
"box_type" : "content_box",
"id" : 0,
"content" : {
"summary" : "In the video series 'ChatGPT - briefly explained', Aljoscha Burchardt from the German Research Center for Artificial Intelligence (DFKI) explains the technology behind the AI chatbot and discusses its influence on various aspects of our lives.",
"entity_type" : "node",
"node_type" : "content_page",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
}
} ],
"name" : "Health"
}, {
"boxes" : [ {
"entity_type" : "box",
"box_type" : "content_box",
"id" : 0,
"content" : {
"summary" : "In the video series 'ChatGPT - briefly explained', Aljoscha Burchardt from the German Research Center for Artificial Intelligence (DFKI) explains the technology behind the AI chatbot and discusses its influence on various aspects of our lives.",
"entity_type" : "node",
"node_type" : "content_page",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
}
}, {
"entity_type" : "box",
"box_type" : "content_box",
"id" : 0,
"content" : {
"summary" : "In the video series 'ChatGPT - briefly explained', Aljoscha Burchardt from the German Research Center for Artificial Intelligence (DFKI) explains the technology behind the AI chatbot and discusses its influence on various aspects of our lives.",
"entity_type" : "node",
"node_type" : "content_page",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
}
} ],
"name" : "Health"
} ],
"categories" : [ {
"boxes" : [ {
"entity_type" : "box",
"box_type" : "content_box",
"id" : 0,
"content" : {
"summary" : "In the video series 'ChatGPT - briefly explained', Aljoscha Burchardt from the German Research Center for Artificial Intelligence (DFKI) explains the technology behind the AI chatbot and discusses its influence on various aspects of our lives.",
"entity_type" : "node",
"node_type" : "content_page",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
}
}, {
"entity_type" : "box",
"box_type" : "content_box",
"id" : 0,
"content" : {
"summary" : "In the video series 'ChatGPT - briefly explained', Aljoscha Burchardt from the German Research Center for Artificial Intelligence (DFKI) explains the technology behind the AI chatbot and discusses its influence on various aspects of our lives.",
"entity_type" : "node",
"node_type" : "content_page",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
}
} ],
"name" : "Health"
}, {
"boxes" : [ {
"entity_type" : "box",
"box_type" : "content_box",
"id" : 0,
"content" : {
"summary" : "In the video series 'ChatGPT - briefly explained', Aljoscha Burchardt from the German Research Center for Artificial Intelligence (DFKI) explains the technology behind the AI chatbot and discusses its influence on various aspects of our lives.",
"entity_type" : "node",
"node_type" : "content_page",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
}
}, {
"entity_type" : "box",
"box_type" : "content_box",
"id" : 0,
"content" : {
"summary" : "In the video series 'ChatGPT - briefly explained', Aljoscha Burchardt from the German Research Center for Artificial Intelligence (DFKI) explains the technology behind the AI chatbot and discusses its influence on various aspects of our lives.",
"entity_type" : "node",
"node_type" : "content_page",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
}
} ],
"name" : "Health"
} ],
"page_description" : "Company overview page"
}application/jsonget /document_search{
"sub_facets" : {
"facet_id" : "location",
"label" : "Location",
"items" : [ {
"item_id" : 45,
"count" : 10,
"label" : "Berlin"
}, {
"item_id" : 45,
"count" : 10,
"label" : "Berlin"
} ]
},
"search_results" : [ {
"summary" : "summary",
"last_updated" : "09.09.2025",
"documents" : "https://example.com/example_file.pdf",
"title" : {
"is_link" : true,
"text" : "text"
},
"tags" : {
"label" : "Tags",
"value" : [ "value", "value" ]
},
"entity_type" : "node",
"node_type" : "document",
"topic" : {
"label" : "Topic",
"value" : [ "value", "value" ]
},
"links" : {
"link_type" : "external",
"link_text" : "Demodokument",
"url" : "https://example.com"
},
"location" : {
"label" : "Location",
"value" : [ "value", "value" ]
},
"id" : 0,
"excerpt" : "",
"organizational_unit" : {
"label" : "Organizational Unit",
"value" : [ "value", "value" ]
},
"document_type" : "document_type"
}, {
"summary" : "summary",
"last_updated" : "09.09.2025",
"documents" : "https://example.com/example_file.pdf",
"title" : {
"is_link" : true,
"text" : "text"
},
"tags" : {
"label" : "Tags",
"value" : [ "value", "value" ]
},
"entity_type" : "node",
"node_type" : "document",
"topic" : {
"label" : "Topic",
"value" : [ "value", "value" ]
},
"links" : {
"link_type" : "external",
"link_text" : "Demodokument",
"url" : "https://example.com"
},
"location" : {
"label" : "Location",
"value" : [ "value", "value" ]
},
"id" : 0,
"excerpt" : "",
"organizational_unit" : {
"label" : "Organizational Unit",
"value" : [ "value", "value" ]
},
"document_type" : "document_type"
} ]
}application/jsonget /employee_directory/employees[ {
"uid" : 1,
"mail" : "someone@example.com",
"flagged" : true,
"name" : "Clara",
"picture" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
}
}, {
"uid" : 1,
"mail" : "someone@example.com",
"flagged" : true,
"name" : "Clara",
"picture" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
}
} ]application/jsonget /employee_jubilees{
"employee_jubilees" : ""
}application/jsonpost /event/bookmarkapplication/json{
"success" : true,
"is_bookmarked" : true,
"message" : "Event bookmarked successfully."
}application/jsondelete /event/{nid}/registrations{
"success" : true
}application/jsonget /event/{nid}/registrations/downloadtext/csvget /event/{nid}/registrations{
"total" : 12,
"registrations" : [ {
"uid" : 27,
"registeredAtTimestamp" : 1777289100,
"note" : "Will arrive 10 minutes early.",
"thumbnail" : {
"key" : ""
},
"flaggingId" : 145,
"name" : "Jane Doe",
"registeredAt" : "27.04.2026 - 10:45",
"email" : "jane.doe@example.com"
}, {
"uid" : 27,
"registeredAtTimestamp" : 1777289100,
"note" : "Will arrive 10 minutes early.",
"thumbnail" : {
"key" : ""
},
"flaggingId" : 145,
"name" : "Jane Doe",
"registeredAt" : "27.04.2026 - 10:45",
"email" : "jane.doe@example.com"
} ],
"canDownload" : true,
"canDelete" : true
}application/jsonpost /event/{nid}/registrationsapplication/json{
"alreadyRegistered" : true,
"flaggingId" : 145
}{
"alreadyRegistered" : true,
"flaggingId" : 145
}application/jsonget /event/{type}Returns event data based on the type path parameter. Supports retrieving events (all or user-specific), event types, event categories, event settings, and calendar events.
all and my types. default: overview all or omit for no filter. Applies to all, my, and calendar types. default: null all or omit for no filter. Applies to all, my, and calendar types. default: null all and my types. default: 0 all and my types. default: 0 all and my types. default: 0 calendar. Must be between 2025 and 2100. default: null calendar. Must be between 1 and 12. default: null true, only returns bookmarked events for the current user. Only applies to calendar type. default: false {
"grouped" : true,
"ongoing" : {
"total" : 0,
"offset" : 0,
"limit" : 8,
"has_more" : true,
"events" : [ {
"end_date" : "2000-01-23T04:56:07.000+00:00",
"summary" : "Join us for the annual company summit...",
"formatted_date_time" : "Monday, 15. June 2026, 09:00 - 17:00",
"image_url" : "/sites/default/files/styles/boxes_16_9/public/event.jpg",
"registration_status" : "registered",
"title" : "Annual Company Summit",
"event_category" : {
"label" : "Sports",
"tid" : 7
},
"url" : "/en/events/annual-company-summit",
"event_type" : "Conference",
"is_bookmarked" : true,
"location" : [ "Berlin", "Munich" ],
"is_all_day" : true,
"id" : 42,
"start_date" : "2000-01-23T04:56:07.000+00:00",
"date_parts" : {
"is_range" : true,
"start" : {
"month" : "Jun",
"day" : "15"
},
"end" : {
"month" : "Jun",
"day" : "15"
}
}
}, {
"end_date" : "2000-01-23T04:56:07.000+00:00",
"summary" : "Join us for the annual company summit...",
"formatted_date_time" : "Monday, 15. June 2026, 09:00 - 17:00",
"image_url" : "/sites/default/files/styles/boxes_16_9/public/event.jpg",
"registration_status" : "registered",
"title" : "Annual Company Summit",
"event_category" : {
"label" : "Sports",
"tid" : 7
},
"url" : "/en/events/annual-company-summit",
"event_type" : "Conference",
"is_bookmarked" : true,
"location" : [ "Berlin", "Munich" ],
"is_all_day" : true,
"id" : 42,
"start_date" : "2000-01-23T04:56:07.000+00:00",
"date_parts" : {
"is_range" : true,
"start" : {
"month" : "Jun",
"day" : "15"
},
"end" : {
"month" : "Jun",
"day" : "15"
}
}
} ]
},
"past" : {
"total" : 0,
"offset" : 0,
"limit" : 8,
"has_more" : true,
"events" : [ {
"end_date" : "2000-01-23T04:56:07.000+00:00",
"summary" : "Join us for the annual company summit...",
"formatted_date_time" : "Monday, 15. June 2026, 09:00 - 17:00",
"image_url" : "/sites/default/files/styles/boxes_16_9/public/event.jpg",
"registration_status" : "registered",
"title" : "Annual Company Summit",
"event_category" : {
"label" : "Sports",
"tid" : 7
},
"url" : "/en/events/annual-company-summit",
"event_type" : "Conference",
"is_bookmarked" : true,
"location" : [ "Berlin", "Munich" ],
"is_all_day" : true,
"id" : 42,
"start_date" : "2000-01-23T04:56:07.000+00:00",
"date_parts" : {
"is_range" : true,
"start" : {
"month" : "Jun",
"day" : "15"
},
"end" : {
"month" : "Jun",
"day" : "15"
}
}
}, {
"end_date" : "2000-01-23T04:56:07.000+00:00",
"summary" : "Join us for the annual company summit...",
"formatted_date_time" : "Monday, 15. June 2026, 09:00 - 17:00",
"image_url" : "/sites/default/files/styles/boxes_16_9/public/event.jpg",
"registration_status" : "registered",
"title" : "Annual Company Summit",
"event_category" : {
"label" : "Sports",
"tid" : 7
},
"url" : "/en/events/annual-company-summit",
"event_type" : "Conference",
"is_bookmarked" : true,
"location" : [ "Berlin", "Munich" ],
"is_all_day" : true,
"id" : 42,
"start_date" : "2000-01-23T04:56:07.000+00:00",
"date_parts" : {
"is_range" : true,
"start" : {
"month" : "Jun",
"day" : "15"
},
"end" : {
"month" : "Jun",
"day" : "15"
}
}
} ]
},
"upcoming" : {
"total" : 0,
"offset" : 0,
"limit" : 8,
"has_more" : true,
"events" : [ {
"end_date" : "2000-01-23T04:56:07.000+00:00",
"summary" : "Join us for the annual company summit...",
"formatted_date_time" : "Monday, 15. June 2026, 09:00 - 17:00",
"image_url" : "/sites/default/files/styles/boxes_16_9/public/event.jpg",
"registration_status" : "registered",
"title" : "Annual Company Summit",
"event_category" : {
"label" : "Sports",
"tid" : 7
},
"url" : "/en/events/annual-company-summit",
"event_type" : "Conference",
"is_bookmarked" : true,
"location" : [ "Berlin", "Munich" ],
"is_all_day" : true,
"id" : 42,
"start_date" : "2000-01-23T04:56:07.000+00:00",
"date_parts" : {
"is_range" : true,
"start" : {
"month" : "Jun",
"day" : "15"
},
"end" : {
"month" : "Jun",
"day" : "15"
}
}
}, {
"end_date" : "2000-01-23T04:56:07.000+00:00",
"summary" : "Join us for the annual company summit...",
"formatted_date_time" : "Monday, 15. June 2026, 09:00 - 17:00",
"image_url" : "/sites/default/files/styles/boxes_16_9/public/event.jpg",
"registration_status" : "registered",
"title" : "Annual Company Summit",
"event_category" : {
"label" : "Sports",
"tid" : 7
},
"url" : "/en/events/annual-company-summit",
"event_type" : "Conference",
"is_bookmarked" : true,
"location" : [ "Berlin", "Munich" ],
"is_all_day" : true,
"id" : 42,
"start_date" : "2000-01-23T04:56:07.000+00:00",
"date_parts" : {
"is_range" : true,
"start" : {
"month" : "Jun",
"day" : "15"
},
"end" : {
"month" : "Jun",
"day" : "15"
}
}
} ]
}
}application/jsonEvent data for the requested type. The response shape depends on type and filter:
all / my with filter=overview (default): grouped response object.all / my with filter=ongoing|upcoming|past: flat list response object.event-types / event-categories: array of term option objects.settings: event settings object.calendar: array of event item objects.Invalid parameter value. Possible causes:
type path parameter value.event_type or event_category query parameter.year (2025–2100) or month (1–12) for type=calendar.access content permission.
get /events{
"ongoing" : [ {
"summary" : "Digital Workplace bedeutet mehr, als nur Technologie ...",
"event_date_month" : "Apr.",
"entity_type" : "node",
"node_type" : "event",
"event_start_date_full" : "Dienstag, 30. April 2024 - 00:00",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"event_date_day" : "09",
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
},
"kicker" : "Dachzeile"
}, {
"summary" : "Digital Workplace bedeutet mehr, als nur Technologie ...",
"event_date_month" : "Apr.",
"entity_type" : "node",
"node_type" : "event",
"event_start_date_full" : "Dienstag, 30. April 2024 - 00:00",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"event_date_day" : "09",
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
},
"kicker" : "Dachzeile"
} ],
"expired" : [ {
"summary" : "Digital Workplace bedeutet mehr, als nur Technologie ...",
"event_date_month" : "Apr.",
"entity_type" : "node",
"node_type" : "event",
"event_start_date_full" : "Dienstag, 30. April 2024 - 00:00",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"event_date_day" : "09",
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
},
"kicker" : "Dachzeile"
}, {
"summary" : "Digital Workplace bedeutet mehr, als nur Technologie ...",
"event_date_month" : "Apr.",
"entity_type" : "node",
"node_type" : "event",
"event_start_date_full" : "Dienstag, 30. April 2024 - 00:00",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"event_date_day" : "09",
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
},
"kicker" : "Dachzeile"
} ],
"description" : "You can find all events on this event overview page",
"title" : "Events",
"upcoming" : [ {
"summary" : "Digital Workplace bedeutet mehr, als nur Technologie ...",
"event_date_month" : "Apr.",
"entity_type" : "node",
"node_type" : "event",
"event_start_date_full" : "Dienstag, 30. April 2024 - 00:00",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"event_date_day" : "09",
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
},
"kicker" : "Dachzeile"
}, {
"summary" : "Digital Workplace bedeutet mehr, als nur Technologie ...",
"event_date_month" : "Apr.",
"entity_type" : "node",
"node_type" : "event",
"event_start_date_full" : "Dienstag, 30. April 2024 - 00:00",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"event_date_day" : "09",
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
},
"kicker" : "Dachzeile"
} ]
}application/jsonget /magazine_topic/{topic}{
"articles" : [ {
"summary" : "In the video series 'ChatGPT - briefly explained', Aljoscha Burchardt from the German Research Center for Artificial Intelligence (DFKI) explains the technology behind the AI chatbot and discusses its influence on various aspects of our lives.",
"entity_type" : "node",
"node_type" : "article",
"magazine_channel" : "Marketing",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
}, {
"summary" : "In the video series 'ChatGPT - briefly explained', Aljoscha Burchardt from the German Research Center for Artificial Intelligence (DFKI) explains the technology behind the AI chatbot and discusses its influence on various aspects of our lives.",
"entity_type" : "node",
"node_type" : "article",
"magazine_channel" : "Marketing",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
} ]
}application/jsonget /new_colleagues{
"new_colleagues" : [ {
"entity_type" : "user",
"user_type" : "user",
"user_picture" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"name" : "John Doe",
"location" : "Berlin",
"id" : 0,
"department" : "HR",
"organizational_unit" : "Marketing",
"employed_since" : "01.01.1970"
}, {
"entity_type" : "user",
"user_type" : "user",
"user_picture" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"name" : "John Doe",
"location" : "Berlin",
"id" : 0,
"department" : "HR",
"organizational_unit" : "Marketing",
"employed_since" : "01.01.1970"
} ]
}application/jsonget /news_menu[ {
"label" : "All News",
"id" : "news"
}, {
"label" : "All News",
"id" : "news"
} ]application/jsonget /news/{news_page}{
"news" : [ {
"summary" : "Digital Workplace bedeutet mehr, als nur Technologie ...",
"entity_type" : "node",
"node_type" : "content_page",
"corporate_news_channel" : "corporate_news_channel",
"id" : 42,
"news_channel" : "news_channel",
"title" : {
"text" : "This is a node title."
},
"published_at" : "04.09.2023",
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
}, {
"summary" : "Digital Workplace bedeutet mehr, als nur Technologie ...",
"entity_type" : "node",
"node_type" : "content_page",
"corporate_news_channel" : "corporate_news_channel",
"id" : 42,
"news_channel" : "news_channel",
"title" : {
"text" : "This is a node title."
},
"published_at" : "04.09.2023",
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
} ],
"news_channel_filter" : [ {
"name" : "Marketing",
"id" : 0
}, {
"name" : "Marketing",
"id" : 0
} ]
}application/jsonget /piipe_picture_gallery[ {
"date" : "1739461059",
"flag" : {
"like_count" : "2",
"rock_flagged" : false,
"rock_count" : "1",
"heart_count" : "2",
"heart_flagged" : true,
"like_flagged" : true
},
"hashtags" : [ {
"name" : "relatable",
"id" : "496"
}, {
"name" : "relatable",
"id" : "496"
} ],
"author" : {
"langcode" : "Germany",
"name" : "John Doe",
"picture" : {
"alt" : "Profile picture for user John Doe",
"url" : "/system/files/styles/thumbnail/private/medialibrary/profile_image.jpg?h=cc71e594&itok=yAsmmMts"
}
},
"permissions" : {
"edit" : true,
"delete" : true
},
"description" : "This is a description text.",
"id" : "1",
"title" : "This is a post title",
"url" : "/system/files/styles/picture_gallery/private/picture_gallery/pexels-diiefao-2258357.jpg?itok=LVC9QA64"
}, {
"date" : "1739461059",
"flag" : {
"like_count" : "2",
"rock_flagged" : false,
"rock_count" : "1",
"heart_count" : "2",
"heart_flagged" : true,
"like_flagged" : true
},
"hashtags" : [ {
"name" : "relatable",
"id" : "496"
}, {
"name" : "relatable",
"id" : "496"
} ],
"author" : {
"langcode" : "Germany",
"name" : "John Doe",
"picture" : {
"alt" : "Profile picture for user John Doe",
"url" : "/system/files/styles/thumbnail/private/medialibrary/profile_image.jpg?h=cc71e594&itok=yAsmmMts"
}
},
"permissions" : {
"edit" : true,
"delete" : true
},
"description" : "This is a description text.",
"id" : "1",
"title" : "This is a post title",
"url" : "/system/files/styles/picture_gallery/private/picture_gallery/pexels-diiefao-2258357.jpg?itok=LVC9QA64"
} ]application/jsonpatch /piipe_picture_galleryTo flag a gallery post, make a POST request to /piipe_flags/flag and pass the following parameters to the body:
{
"flag_id": "gallery_post_FLAG",
"entity_type": "gallery_post",
"entity_id": "ID",
"action": "flag"
}
where FLAG is one of [like, rock, heart] and ID is the gallery post ID.
application/json{
"is_last" : true
}application/jsonget /room_search{
"sub_facets" : {
"facet_id" : "location",
"label" : "Location",
"items" : [ {
"item_id" : 45,
"count" : 10,
"label" : "Berlin"
}, {
"item_id" : 45,
"count" : 10,
"label" : "Berlin"
} ]
},
"search_results" : [ {
"last_updated" : "2000-01-23",
"entity_type" : "node",
"node_type" : "room",
"location" : [ {
"id" : "277",
"text" : "Paris"
}, {
"id" : "277",
"text" : "Paris"
} ],
"id" : "1788",
"title" : {
"is_link" : true,
"text" : "Search: Room"
},
"excerpt" : "",
"number_of_seats" : {
"label" : "Seats",
"value" : 4
},
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
}, {
"last_updated" : "2000-01-23",
"entity_type" : "node",
"node_type" : "room",
"location" : [ {
"id" : "277",
"text" : "Paris"
}, {
"id" : "277",
"text" : "Paris"
} ],
"id" : "1788",
"title" : {
"is_link" : true,
"text" : "Search: Room"
},
"excerpt" : "",
"number_of_seats" : {
"label" : "Seats",
"value" : 4
},
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
} ]
}application/jsonget /search{
"sub_facets" : {
"facet_id" : "location",
"label" : "Location",
"items" : [ {
"item_id" : 45,
"count" : 10,
"label" : "Berlin"
}, {
"item_id" : 45,
"count" : 10,
"label" : "Berlin"
} ]
},
"main_facet" : {
"facet_id" : "type",
"label" : "Type",
"items" : [ {
"label" : "Content",
"item_id" : "node",
"count" : 10
} ]
},
"search_results" : [ {
"node_type" : "content_page",
"entity_type" : "node",
"node_type_label" : "Content Page",
"id" : 0,
"excerpt" : "… some random text … *(here the word \"random\" was searched)*",
"title" : "This is a node title.",
"published_at" : "31.01.2025"
}, {
"node_type" : "content_page",
"entity_type" : "node",
"node_type_label" : "Content Page",
"id" : 0,
"excerpt" : "… some random text … *(here the word \"random\" was searched)*",
"title" : "This is a node title.",
"published_at" : "31.01.2025"
} ],
"result_count" : 100
}application/jsonget /tags/{page}{
"tags" : [ {
"entity_type" : "taxonomy_term",
"name" : "Neocosmo",
"id" : 42,
"taxonomy_term_type" : "news_channel"
}, {
"entity_type" : "taxonomy_term",
"name" : "Neocosmo",
"id" : 42,
"taxonomy_term_type" : "news_channel"
} ]
}application/jsonget /taxonomy_page/{tid}{
"data" : [ {
"summary" : "In the video series 'ChatGPT - briefly explained', Aljoscha Burchardt from the German Research Center for Artificial Intelligence (DFKI) explains the technology behind the AI chatbot and discusses its influence on various aspects of our lives.",
"entity_type" : "node",
"node_type" : "content_page",
"magazine_channel" : "magazine_channel",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"published_at" : "04.09.2023",
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
}, {
"summary" : "In the video series 'ChatGPT - briefly explained', Aljoscha Burchardt from the German Research Center for Artificial Intelligence (DFKI) explains the technology behind the AI chatbot and discusses its influence on various aspects of our lives.",
"entity_type" : "node",
"node_type" : "content_page",
"magazine_channel" : "magazine_channel",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"published_at" : "04.09.2023",
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
} ],
"title" : "Marketing"
}application/jsonget /vehicle_search{
"sub_facets" : [ {
"facet_id" : "location",
"label" : "Location",
"items" : [ {
"item_id" : 45,
"count" : 10,
"label" : "Berlin"
}, {
"item_id" : 45,
"count" : 10,
"label" : "Berlin"
} ]
}, {
"facet_id" : "location",
"label" : "Location",
"items" : [ {
"item_id" : 45,
"count" : 10,
"label" : "Berlin"
}, {
"item_id" : 45,
"count" : 10,
"label" : "Berlin"
} ]
} ],
"search_results" : [ {
"last_updated" : "2000-01-23",
"entity_type" : "node",
"node_type" : "vehicle",
"location" : {
"label" : "Location",
"value" : [ {
"id" : "48",
"text" : "Berlin"
}, {
"id" : "48",
"text" : "Berlin"
} ]
},
"model" : {
"label" : "Year of Construction",
"value" : "2020"
},
"id" : "1305",
"year_of_construction" : {
"label" : "Year of Construction",
"value" : "2020"
},
"fuel_type" : {
"label" : "Fuel type",
"value" : {
"id" : "462",
"text" : "Gasoline"
}
},
"title" : {
"is_link" : true,
"text" : "Yamaha Bike"
},
"excerpt" : "",
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
}, {
"last_updated" : "2000-01-23",
"entity_type" : "node",
"node_type" : "vehicle",
"location" : {
"label" : "Location",
"value" : [ {
"id" : "48",
"text" : "Berlin"
}, {
"id" : "48",
"text" : "Berlin"
} ]
},
"model" : {
"label" : "Year of Construction",
"value" : "2020"
},
"id" : "1305",
"year_of_construction" : {
"label" : "Year of Construction",
"value" : "2020"
},
"fuel_type" : {
"label" : "Fuel type",
"value" : {
"id" : "462",
"text" : "Gasoline"
}
},
"title" : {
"is_link" : true,
"text" : "Yamaha Bike"
},
"excerpt" : "",
"header_media" : {
"owner" : "John Doe",
"entity_type" : "media",
"file" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
},
"media_type" : "image",
"description" : "Image description",
"id" : 0,
"source" : {
"link_type" : "external",
"url_text" : "Link",
"link_text" : "Press to go to website",
"url" : "https://example.com"
},
"type" : "image"
}
} ]
}application/jsonget /videos{
"data" : [ {
"summary" : "This is video description.",
"entity_type" : "node",
"node_type" : "magazine_video_article",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"header_media" : ""
}, {
"summary" : "This is video description.",
"entity_type" : "node",
"node_type" : "magazine_video_article",
"id" : 42,
"title" : {
"text" : "This is a node title."
},
"header_media" : ""
} ],
"title" : "Videos"
}application/jsonget /wiki_overview{
"data" : [ {
"image" : "",
"entity_type" : "taxonomy_term",
"name" : "Social Media Marketing",
"description" : "Social media marketing wiki",
"id" : 42,
"taxonomy_term_type" : "news_channel"
}, {
"image" : "",
"entity_type" : "taxonomy_term",
"name" : "Social Media Marketing",
"description" : "Social media marketing wiki",
"id" : 42,
"taxonomy_term_type" : "news_channel"
} ],
"description" : "description",
"title" : "title"
}application/jsonget /wiki_term_overview/{term_id}{
"data" : [ {
"entity_type" : "node",
"node_type" : "wiki_content",
"id" : 42,
"title" : {
"text" : "This is a node title."
}
}, {
"entity_type" : "node",
"node_type" : "wiki_content",
"id" : 42,
"title" : {
"text" : "This is a node title."
}
} ],
"title" : "Social media marketing wiki"
}application/jsonpost /openid_connect_login/{oidc_client_name}application/json{
"access_token" : "access_token",
"refresh_token" : "refresh_token",
"tfa_skips_allowed" : 0,
"jwt_token" : "jwt_token",
"csrf_token" : "csrf_token",
"logout_token" : "logout_token",
"user" : "{}"
}application/jsonget /refresh_tokenWhen an access token has expired, use a refresh token to generate a new access token as well as a new refresh token.
Note: The refresh token must be used in the the 'Authorization' header to authorize against this endpoint. Trying to use the refresh token to authorize against any other endpoint will fail. The same argument is valid for the access token the other way around.
{
"access_token" : "access_token",
"refresh_token" : "refresh_token",
"jwt_token" : "jwt_token"
}application/jsonpost /user/code_registerapplication/json{
"access_token" : "access_token",
"refresh_token" : "refresh_token",
"tfa_skips_allowed" : 0,
"jwt_token" : "jwt_token",
"csrf_token" : "csrf_token",
"logout_token" : "logout_token",
"user" : "{}"
}{
"message" : "Validation failed.",
"errors" : {
"mail" : "This value is not a valid email address.",
"pass" : "This value is too short. It should have 8 characters or more."
}
}application/jsonget /user-login-check{
"result" : true,
"user" : "{}"
}application/jsonpost /user-loginAuthenticate with username and password.
Response flows:
application/json{
"access_token" : "access_token",
"refresh_token" : "refresh_token",
"tfa_skips_allowed" : 0,
"jwt_token" : "jwt_token",
"csrf_token" : "csrf_token",
"logout_token" : "logout_token",
"user" : "{}"
}{
"allowed_methods" : [ "tfa_totp" ],
"expires_at" : 1743342000,
"challenge_token" : "a3f1c2d4e5b6...",
"auth_state" : "challenge_required"
}application/jsonchallenge_token and
a one-time code to /user-login/tfa to complete the login.
_user_login_post_202_response
post /user-login/tfachallenge_token (received from POST /user-login) together
with the one-time code from the user's second-factor device. On success,
the login is finalized and JWT tokens and user object are returned.application/json{
"access_token" : "access_token",
"refresh_token" : "refresh_token",
"tfa_skips_allowed" : 0,
"jwt_token" : "jwt_token",
"csrf_token" : "csrf_token",
"logout_token" : "logout_token",
"user" : "{}"
}application/jsonchallenge_token, code).
Retry-After response header.
post /user-logoutapplication/jsonpost /user/logout_format=json to receive a JSON response instead of an HTML redirect.get /user_profile/edit/{uid}Returns edit form data for a user profile. The response shape depends on the API version:
/api/v1/user_profile/edit/{uid}) – sections and fields are returned as separate
keyed objects under profile. Fields include edit-specific properties: private,
required, options, and placeholder./api/v2/user_profile/edit/{uid}) – sections are returned as an ordered array
under profile.sections, each containing a nested fields array sorted by weight.{
"image" : {
"settings" : {
"min_height" : 200,
"min_width" : 200
},
"default" : {
"alt" : "Default user picture for user superadmin",
"url" : "/themes/contrib/piipe_backend/images/icons/user/user.svg"
},
"value" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
}
},
"profile" : {
"fields" : {
"key" : {
"parent" : "organization_data",
"title_required" : 1,
"private" : false,
"edit" : "1",
"weight" : "-26",
"label" : "Country",
"type" : "entity_reference",
"machine_name" : "field_country",
"click" : "0",
"delete" : "Delete",
"required" : true,
"selection_limit" : 3,
"protocol_type" : "protocol_type",
"hide" : "0",
"depth" : "1",
"multi_select" : 0,
"new_tab" : "0",
"options" : {
"46" : "Germany",
"60" : "France"
},
"private_for_others" : true,
"taxonomy_link" : "1",
"id" : "field_country",
"placeholder" : {
"text" : "text",
"title" : "title",
"uri" : "uri"
},
"value" : "46"
}
},
"sections" : {
"key" : {
"parent" : "none",
"edit" : 0,
"weight" : "-27",
"label" : "Organization data",
"type" : "section",
"machine_name" : "organization_data",
"click" : 0,
"delete" : "Delete",
"protocol_type" : "protocol_type",
"hide" : 0,
"depth" : "0",
"new_tab" : 0,
"private_for_others" : true,
"id" : "organization_data",
"taxonomy_link" : 0
}
}
}
}application/jsonpatch /user_profile/edit/{uid}Updates a user's profile fields and/or profile image. The response depends on the API version:
/api/v1/user_profile/edit/{uid}) - returns the updated profile/api/v2/user_profile/edit/{uid}) - returns the full updated user profile in the
same structure as GET /api/v2/user_profile/{uid}application/json{
"image" : {
"value" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
}
},
"org_chart" : {
"supervisor_id" : "260",
"supervisor" : "The boss",
"users" : [ {
"uid" : "1",
"name" : "Super Admin-Schmidt",
"subordinates" : [ {
"uid" : "4",
"name" : "Katharina XYZ"
}, {
"uid" : "4",
"name" : "Katharina XYZ"
} ]
}, {
"uid" : "1",
"name" : "Super Admin-Schmidt",
"subordinates" : [ {
"uid" : "4",
"name" : "Katharina XYZ"
}, {
"uid" : "4",
"name" : "Katharina XYZ"
} ]
} ]
},
"profile" : {
"field_topic" : [ {
"label" : "Saarbrücken",
"url" : "/taxonomy/term/47"
}, {
"label" : "Saarbrücken",
"url" : "/taxonomy/term/47"
} ],
"field_location" : [ {
"label" : "Saarbrücken",
"url" : "/taxonomy/term/47"
}, {
"label" : "Saarbrücken",
"url" : "/taxonomy/term/47"
} ],
"field_organizational_unit" : [ {
"label" : "Saarbrücken",
"url" : "/taxonomy/term/47"
}, {
"label" : "Saarbrücken",
"url" : "/taxonomy/term/47"
} ],
"fields" : {
"key" : {
"parent" : "organization_data",
"edit" : "1",
"weight" : "-26",
"label" : "Country",
"type" : "entity_reference",
"machine_name" : "field_country",
"click" : "0",
"delete" : "Delete",
"selection_limit" : 3,
"protocol_type" : "protocol_type",
"hide" : "0",
"depth" : "1",
"multi_select" : 0,
"new_tab" : "0",
"options" : {
"46" : "Germany",
"60" : "France"
},
"private_for_others" : true,
"taxonomy_link" : "1",
"id" : "field_country",
"value" : "46"
}
},
"sections" : {
"key" : {
"parent" : "none",
"edit" : 0,
"weight" : "-27",
"label" : "Organization data",
"type" : "section",
"machine_name" : "organization_data",
"click" : 0,
"delete" : "Delete",
"protocol_type" : "protocol_type",
"hide" : 0,
"depth" : "0",
"new_tab" : 0,
"private_for_others" : true,
"id" : "organization_data",
"taxonomy_link" : 0
}
},
"private_fields" : [ "private_fields", "private_fields" ]
}
}application/jsonBad request. Possible causes:
list_string value is not in the field's allowed values.uri is not a valid absolute URL.get /user_profile/{uid}Returns the user profile for the given user ID. The response shape depends on the API version prefix used in the URL:
/api/v1/user_profile/{uid}) – sections and fields are
returned as separate keyed objects. Fields reference their parent
section via the parent property./api/v2/user_profile/{uid}) – sections are returned as an
ordered array, each containing a nested fields array. Entity
reference fields with taxonomy_link enabled include a route_name
property.{
"image" : {
"value" : {
"alt" : "image alt text",
"url" : "https://example.com/example_image.jpg"
}
},
"org_chart" : {
"supervisor_id" : "260",
"supervisor" : "The boss",
"users" : [ {
"uid" : "1",
"name" : "Super Admin-Schmidt",
"subordinates" : [ {
"uid" : "4",
"name" : "Katharina XYZ"
}, {
"uid" : "4",
"name" : "Katharina XYZ"
} ]
}, {
"uid" : "1",
"name" : "Super Admin-Schmidt",
"subordinates" : [ {
"uid" : "4",
"name" : "Katharina XYZ"
}, {
"uid" : "4",
"name" : "Katharina XYZ"
} ]
} ]
},
"profile" : {
"field_topic" : [ {
"label" : "Saarbrücken",
"url" : "/taxonomy/term/47"
}, {
"label" : "Saarbrücken",
"url" : "/taxonomy/term/47"
} ],
"field_location" : [ {
"label" : "Saarbrücken",
"url" : "/taxonomy/term/47"
}, {
"label" : "Saarbrücken",
"url" : "/taxonomy/term/47"
} ],
"field_organizational_unit" : [ {
"label" : "Saarbrücken",
"url" : "/taxonomy/term/47"
}, {
"label" : "Saarbrücken",
"url" : "/taxonomy/term/47"
} ],
"fields" : {
"key" : {
"parent" : "organization_data",
"edit" : "1",
"weight" : "-26",
"label" : "Country",
"type" : "entity_reference",
"machine_name" : "field_country",
"click" : "0",
"delete" : "Delete",
"selection_limit" : 3,
"protocol_type" : "protocol_type",
"hide" : "0",
"depth" : "1",
"multi_select" : 0,
"new_tab" : "0",
"options" : {
"46" : "Germany",
"60" : "France"
},
"private_for_others" : true,
"taxonomy_link" : "1",
"id" : "field_country",
"value" : "46"
}
},
"sections" : {
"key" : {
"parent" : "none",
"edit" : 0,
"weight" : "-27",
"label" : "Organization data",
"type" : "section",
"machine_name" : "organization_data",
"click" : 0,
"delete" : "Delete",
"protocol_type" : "protocol_type",
"hide" : 0,
"depth" : "0",
"new_tab" : 0,
"private_for_others" : true,
"id" : "organization_data",
"taxonomy_link" : 0
}
},
"private_fields" : [ "private_fields", "private_fields" ]
},
"details" : {
"own_page" : true,
"username" : "superadmin"
}
}application/jsonpost /user/registerapplication/jsonget /user_session{
"csrf_token" : "1234567890abcdef1234567890abcdef",
"logout_token" : "1234567890abcdef1234567890abcdef"
}application/jsonget /user_settings[ {
"description" : "On this page you will find all settings to customize the system to your personal needs.",
"section" : [ {
"section_id" : "language_location",
"section_elements" : [ {
"settings_id" : "UserSettingsElementLanguage",
"data" : {
"current_language" : "en",
"label" : "Language",
"language_options" : [ {
"name" : "English",
"id" : "en"
}, {
"name" : "English",
"id" : "en"
} ]
},
"description" : "Here you can set the language on Piipe Workplace. The language settings affect Piipe Workplace' content including News Channels.",
"title" : "title"
}, {
"settings_id" : "UserSettingsElementLanguage",
"data" : {
"current_language" : "en",
"label" : "Language",
"language_options" : [ {
"name" : "English",
"id" : "en"
}, {
"name" : "English",
"id" : "en"
} ]
},
"description" : "Here you can set the language on Piipe Workplace. The language settings affect Piipe Workplace' content including News Channels.",
"title" : "title"
} ],
"title" : "Language and location"
}, {
"section_id" : "language_location",
"section_elements" : [ {
"settings_id" : "UserSettingsElementLanguage",
"data" : {
"current_language" : "en",
"label" : "Language",
"language_options" : [ {
"name" : "English",
"id" : "en"
}, {
"name" : "English",
"id" : "en"
} ]
},
"description" : "Here you can set the language on Piipe Workplace. The language settings affect Piipe Workplace' content including News Channels.",
"title" : "title"
}, {
"settings_id" : "UserSettingsElementLanguage",
"data" : {
"current_language" : "en",
"label" : "Language",
"language_options" : [ {
"name" : "English",
"id" : "en"
}, {
"name" : "English",
"id" : "en"
} ]
},
"description" : "Here you can set the language on Piipe Workplace. The language settings affect Piipe Workplace' content including News Channels.",
"title" : "title"
} ],
"title" : "Language and location"
} ],
"title" : "Settings"
}, {
"description" : "On this page you will find all settings to customize the system to your personal needs.",
"section" : [ {
"section_id" : "language_location",
"section_elements" : [ {
"settings_id" : "UserSettingsElementLanguage",
"data" : {
"current_language" : "en",
"label" : "Language",
"language_options" : [ {
"name" : "English",
"id" : "en"
}, {
"name" : "English",
"id" : "en"
} ]
},
"description" : "Here you can set the language on Piipe Workplace. The language settings affect Piipe Workplace' content including News Channels.",
"title" : "title"
}, {
"settings_id" : "UserSettingsElementLanguage",
"data" : {
"current_language" : "en",
"label" : "Language",
"language_options" : [ {
"name" : "English",
"id" : "en"
}, {
"name" : "English",
"id" : "en"
} ]
},
"description" : "Here you can set the language on Piipe Workplace. The language settings affect Piipe Workplace' content including News Channels.",
"title" : "title"
} ],
"title" : "Language and location"
}, {
"section_id" : "language_location",
"section_elements" : [ {
"settings_id" : "UserSettingsElementLanguage",
"data" : {
"current_language" : "en",
"label" : "Language",
"language_options" : [ {
"name" : "English",
"id" : "en"
}, {
"name" : "English",
"id" : "en"
} ]
},
"description" : "Here you can set the language on Piipe Workplace. The language settings affect Piipe Workplace' content including News Channels.",
"title" : "title"
}, {
"settings_id" : "UserSettingsElementLanguage",
"data" : {
"current_language" : "en",
"label" : "Language",
"language_options" : [ {
"name" : "English",
"id" : "en"
}, {
"name" : "English",
"id" : "en"
} ]
},
"description" : "Here you can set the language on Piipe Workplace. The language settings affect Piipe Workplace' content including News Channels.",
"title" : "title"
} ],
"title" : "Language and location"
} ],
"title" : "Settings"
} ]application/jsonpatch /user_settingsapplication/jsonArticle-Teaser - Authored-By - Birthday-Item - Birthday-Item-Base - Birthday_Widget_inner - Box - Box-Base - Box-Page - Box-Page-Reorder-Settings - Bulletin-Config - Bulletin_Config_breadcrumbRoots_inner - Bulletin_Config_permissions_inner - Bulletin_Config_types_inner - Comment - Comment-Request - Comment_Request_comment_body_inner - Comment_Request_comment_type_inner - Comment_Request_entity_type_inner - Comment_Request_field_name_inner - Comment_author - Comment_fields - Comment_fields_comment_body - Comment_fields_subject - Comment_flags - Comment_flags_like - Comment_flags_like_count - Comment_flags_report - Comment_permissions - Comments-List-Response - Comments_List_Response_administrators_inner - Community - Community-Info - Community-Member - CommunityField - CommunityField_default - CommunityField_value - CommunityField_value_oneOf_inner - CommunityMemberAssignRole - CommunityMemberJoin - CommunityMemberLeave - CommunityMemberRemove - CommunityNotification - CommunityNotificationPatchItem - CommunityNotification_id - CommunityUserSettings - CommunityUserSettingsPatchRequest - Community_Info_admins_value - Component - Concrete-Component - Concrete_Component_additional_data - Concrete_Component_additional_data_additional_data_1 - Concrete_Component_additional_data_additional_data_2 - Concrete_Component_data - Concrete_Component_empty - Content - Content-Box - Content-V2 - Content_Box_allOf_content - Context-Box - Context-Reference-Change-Block - Context_Box_allOf_contextual_content - Context_Box_allOf_contextual_content_content - Context_Box_allOf_contextual_content_context_items - Context_Reference_Change_Block_options_inner - Corporate_News_Block_inner - Country-Location-Settings-PATCH - Country-Settings - Country_Settings_country_options_inner - DeleteAllMessages - DeleteSelectedMessages - DeleteSingleMessage - DocumentResult - DocumentResult_links - DocumentResult_location - DocumentResult_organizational_unit - DocumentResult_tags - DocumentResult_title - DocumentResult_topic - DocumentSearch - DocumentSearch_search_results_inner - DocumentSearch_sub_facets - Dossier_Widget_inner - Dynamic-Box-Page - Dynamic_Box_Page_allOf_reorder - Employee_Jubilees_inner - Employees - Employees-Config - Employees_Config_columns_inner - Employees_Config_dropdowns_inner - Employees_Config_dropdowns_inner_field_location_inner - Employees_Config_hierarchical_sorting_inner - Entity-Title - EntityReferenceItem - Entity_Title_title - Event-Available-Categories - Event-Bookmark-Request - Event-Bookmark-Response - Event-Category-Reference - Event-Date-Parts - Event-Date-Segment - Event-Flat-Response - Event-Group-Category - Event-Grouped-Response - Event-Registration-Create-Request - Event-Registration-Delete-Response - Event-Registration-Item - Event-Registration-Upsert-Response - Event-Registrations-Response - Event-Resource-Item - Event-Settings-Response - Event-Term-Option - Event_Settings_Response_category_colors_value - Event_Settings_Response_visible_tabs - Event_Term_Option_value - Events-Page - File - Flag-Status - Frontpage-component-types - Header-Media - Header-Media-Base - Highlight_Widget_Magazine_inner - Image - ImageValue - Language-Settings - Language-Settings-PATCH - Language_Settings_language_options_inner - Link - Link-Box - Link-Box-List - Link-Type - Location-Settings - Location_Settings_location_options_inner - Login - Login-Check - Magazine-Category-Filter-Box - Magazine-Facts-And-Figures-Link - Magazine-Facts-And-Figures-Widget - Magazine_Category_Filter_Box_search_results_inner - Magazine_Collage_Widget_inner - Magazine_Contact_Person_Widget_inner - MarkReadAllMessages - MarkReadMessages - MarkSingleMessage - MarkUnreadAllMessages - Mention-User - Mention_User_userId_inner - Menu-Link - Most-Read-And-Most-Recent - Most-Read-And-Most-Recent-Item - Most-Read-Magazine-2-Item - My-Page-Settings - My-Page-Settings-PATCH - My_Content_Widget_inner - New-Colleagues-Item - New_Colleagues_inner - New_Employees_Block_inner - News-Mandatory-And-Subscribed-Block - News-Menu-Item - News-Page - News_Block_inner - News_Page_news_channel_filter_inner - Node-Base - Node-Base-Extended - Node-Box-View - Node-Default - Node-Event-Widget - Node-Events-Box-View - Node-News-Box-View - Node-Sitemap-List-View - Node-Slider - Node-Teaser - Node-Type - Node-View-Mode - Node_Base_allOf_title - Node_Default_allOf_content - Node_Default_allOf_my_page_button - Notification - Notification-Additional-Data - Notifications-Settings - Notifications-Settings-PATCH - Notifications_Settings_header - Notifications_Settings_notifications_inner - Person-Widget-Item - Picture-Gallery-Post - Picture_Gallery_Post_author - Picture_Gallery_Post_author_picture - Picture_Gallery_Post_flag - Picture_Gallery_Post_hashtags_inner - Picture_Gallery_Post_permissions - Poll-Block - Poll_Block_choices_inner - Press_Article_Widget_inner - Press_Article_Widget_inner_allOf_press_categories - RoomResult - RoomResult_location_inner - RoomResult_number_of_seats - RoomResult_title - RoomSearch - Search - Search-Facet - Search-Result-Excerpt - Search-Result-Node - Search-Result-User - Search_Facet_items_inner - Search_Facet_items_inner_item_id - Search_main_facet - Search_search_results_inner - Search_sub_facets - Section - Simple-Image - Social-Icons - Social_Icons_comments - Social_Icons_heart - Social_Icons_like - Social_Icons_rocks - Social_Icons_views - Static-Box-Page - Static_Box_Page_allOf_categories - Status-Message-Time-Settings - Status-Message-Time-Settings-PATCH - Subscriptions-Settings-PATCH - Subscriptions_Settings_inner - Taxonomy-Term - Taxonomy-Term-Base - Term - Thread-Trace-Response - Thumbnail - Toolbar-Custom-Item - Toolbar-Custom-Item-Link-Payload - Toolbar-Item-Base - Toolbar-Item-Dictionary - Toolbar-Item-Dictionary-Payload - Toolbar-Item-Link - Toolbar-Item-Link-Payload - Toolbar-Item-Section - Toolbar-Item-Section-Base - Toolbar-Item-Subsection - Toolbar-Settings-Object - Toolbar-Settings-Object-Dictionary - Toolbar_Default_Items_value - UpdateMessageStatus - Upload-Completed - Upload-In-Progress - User-Base - User-Code-Register-Validation-Error - User-Profile-Details - User-Profile-Edit-Field - User-Profile-Edit-Image - User-Profile-Edit-Patch-V1 - User-Profile-Edit-V1 - User-Profile-Edit-V1-Profile - User-Profile-Edit-V2 - User-Profile-Edit-V2-Profile - User-Profile-Edit-V2-Section - User-Profile-Field-Base - User-Profile-Image - User-Profile-Org-Chart - User-Profile-Org-Chart-User - User-Profile-Section-Base - User-Profile-Term-Link - User-Profile-V1 - User-Profile-V1-Profile - User-Profile-V2 - User-Profile-V2-Field - User-Profile-V2-Profile - User-Profile-V2-Section - User-Settings - User-Settings-Element - User-Settings-Section - User_Profile_Edit_Field_allOf_placeholder - User_Profile_Edit_Image_default - User_Profile_Edit_Image_settings - User_Profile_Field_Base_value - User_Profile_Org_Chart_User_subordinates_inner - User_Settings_Element_data - VehicleResult - VehicleResult_fuel_type - VehicleResult_fuel_type_value - VehicleResult_location - VehicleResult_location_value_inner - VehicleResult_model - VehicleResult_title - VehicleSearch - Video-Teaser - Vocabulary - Who-s-new-Widget - _api_v1_piipe_picture_gallery_create_post_200_response - _api_v1_piipe_picture_gallery_create_post_request - _api_v1_piipe_picture_gallery_create_post_request_chunk - _birthday_calendar_filters_get_200_response - _birthday_calendar_filters_get_200_response_location_filter_inner - _birthday_calendar_get_200_response - _birthday_calendar_recent_birthday__type__get_200_response_inner - _box_pages__page_name__get_200_response - _box_pages_frontend_boxes_reorder_patch_request - _box_pages_my_page_add_patch_200_response - _box_pages_my_page_add_patch_request - _comment_post_request - _comment_post_request_allOf_entity_id_inner - _comment_post_request_allOf_field_subject_long_inner - _comment_post_request_allOf_pid_inner - _community_joining_request__gid__patch_request - _community_joining_request_post_request - _community_list_get_200_response - _community_members__gid__get_200_response - _community_members__gid__patch_request - _community_post_request - _community_post_request_community_picture - _community_post_request_community_picture_value - _community_post_request_community_picture_value_file - _employee_jubilees_get_200_response - _employee_jubilees_get_200_response_employee_jubilees_allOf_inner - _event__type__get_200_response - _event__type__get_event_type_parameter - _magazine_topic__topic__get_200_response - _new_colleagues_get_200_response - _notifications_get_200_response - _notifications_patch_request - _openid_connect_login__oidc_client_name__post_request - _piipe_comments_media_post_200_response - _piipe_comments_media_post_request - _piipe_comments_media_post_request_chunk - _piipe_comments_mention_post_request - _piipe_flags_flag_post_request - _piipe_picture_gallery_patch_200_response - _piipe_picture_gallery_patch_200_response_oneOf - _piipe_picture_gallery_patch_request - _piipe_picture_gallery_patch_request_chunk - _piipe_picture_gallery_patch_request_chunk_post_data - _piipe_toolbar_custom_objects_patch_request - _piipe_toolbar_custom_objects_patch_request_objectsToBeUpdated_inner - _piipe_toolbar_custom_objects_post_request - _piipe_toolbar_settings_patch_request - _piipe_toolbar_settings_patch_request_objectsToBeUpdated_inner - _piipe_toolbar_settings_post_request - _poll_patch_request - _poll_patch_request_oneOf - _poll_patch_request_oneOf_1 - _refresh_token_get_200_response - _register_device_token__token__delete_403_response - _register_device_token__token__delete_404_response - _register_device_token_post_400_response - _register_device_token_post_request - _scssadmin_get_200_response_value_inner - _tags__page__get_200_response - _taxonomy_page__tid__get_200_response - _user_code_register_post_request - _user_login_post_202_response - _user_login_post_request - _user_login_tfa_post_request - _user_logout_post_request - _user_profile__uid__get_200_response - _user_profile_edit__uid__get_200_response - _user_profile_edit__uid__patch_200_response - _user_profile_edit__uid__patch_request - _user_profile_edit__uid__patch_request_changes - _user_profile_edit__uid__patch_request_changes_editData - _user_profile_edit__uid__patch_request_changes_editData_image - _user_profile_edit__uid__patch_request_changes_editData_image_value - _user_profile_edit__uid__patch_request_changes_editData_image_value_file - _user_profile_edit__uid__patch_request_changes_editData_profile - _user_profile_edit__uid__patch_request_changes_editData_profile_fields_value - _user_profile_edit__uid__patch_request_changes_editData_profile_fields_value_value - _user_profile_edit__uid__patch_request_changes_editData_profile_fields_value_value_oneOf - _user_register_post_request - _user_register_post_request_field_firstname_inner - _user_register_post_request_field_lastname_inner - _user_register_post_request_mail_inner - _user_register_post_request_name_inner - _user_session_get_200_response - _user_settings_patch_request - _videos_get_200_response - _wiki_overview_get_200_response - _wiki_overview_get_200_response_data_inner - _wiki_term_overview__term_id__get_200_response - _wiki_term_overview__term_id__get_200_response_data_inner - Article-Teaser - UpBox - UpBulletin-Config - UpBulletin_Config_permissions_inner - UpComment - UpComment-Request - UpComment_Request_comment_body_inner - UpComment_author - UpComment_fields - UpComment_fields_subject - UpComment_flags_like - UpComment_flags_report - UpComments-List-Response - UpCommunity - UpCommunity-Info - UpCommunity-Member - UpCommunityField - UpCommunityNotification - UpCommunityNotificationPatchItem - UpCommunityUserSettings - UpCommunityUserSettingsPatchRequest - UpConcrete-Component - UpConcrete_Component_additional_data - UpConcrete_Component_data - UpConcrete_Component_empty - UpContent - UpA single Gutenberg block item in the v1 content array.
In v1, every block exposes its content as a rendered HTML string (html) plus a flat set of
block-type-specific keys (e.g. description, file_name, url, type, id, gemstone_title)
placed directly at the top level alongside block_name and inner_blocks.
Content-Box - UpContent-V2 - UpA single Gutenberg block item in the v2 content array.
Key structural change from v1:
html field and scattered block-specific data as
additional flat keys at the same level.html field entirely. All block-specific data is consolidated under
a single attributes object, making the envelope uniform regardless of block type.Both versions share the same block_name / inner_blocks envelope and the same recursive
nesting model. The piipe/column wrapper block is transparent in v2 — its inner blocks are
merged directly into the parent level.
block_name.
Common keys across many block types include text (normalised text content)
and url. Block types that embed other entities (e.g. piipe/linked-content-item,
piipe/distribution-box-item) include a nested node object exported in the
relevant view mode. Content_Box_allOf_content - UpContext-Box - UpContext-Reference-Change-Block - UpContext_Box_allOf_contextual_content_content - UpCorporate_News_Block_inner - UpCountry-Settings - UpDocumentResult - UpDocumentResult_organizational_unit - UpDocumentSearch_search_results_inner - UpDocumentSearch_sub_facets - UpDynamic-Box-Page - UpDynamic_Box_Page_allOf_reorder - UpEmployees - UpEmployees-Config - UpEmployees_Config_dropdowns_inner - UpEvent-Available-Categories - UpEvent-Bookmark-Request - UpEvent-Category-Reference - UpEvent-Date-Parts - UpEvent-Date-Segment - UpEvent-Flat-Response - Uptype=all|my with filter=ongoing|upcoming|past. A single paginated list.Event-Group-Category - UpEvent-Grouped-Response - Uptype=all|my with filter=overview. Events are split into three tab categories.Event-Registration-Create-Request - UpEvent-Registration-Item - UpEvent-Registration-Upsert-Response - UpEvent-Registrations-Response - UpEvent-Resource-Item - Upboxes_16_9. registered when the current user is registered, otherwise null. Event-Settings-Response - Uptype=settings. Contains display configuration for the event module.create event content permission. Event-Term-Option - UpEvent_Settings_Response_visible_tabs - UpEvents-Page - UpFile - UpHeader-Media - UpHighlight_Widget_Magazine_inner - UpLanguage-Settings - UpLink - UpLink-Box - UpLink-Box-List - UpLocation-Settings - UpLogin - UpMagazine-Category-Filter-Box - Up/frontpage/{uuid} or /magazine/{uuid} endpoints. (This component includes two additional properties called 'header' and 'footer' in the parent scheme 'Concrete-Component' inside the property called 'additional_data'.)Magazine-Facts-And-Figures-Widget - UpMagazine_Category_Filter_Box_search_results_inner - UpMagazine_Collage_Widget_inner - UpMention-User - UpMention_User_userId_inner - UpMost-Read-And-Most-Recent - UpMost-Read-And-Most-Recent-Item - UpMy_Content_Widget_inner - UpNew-Colleagues-Item - UpNew_Colleagues_inner - UpNew_Employees_Block_inner - UpNews-Page - UpNode-Base-Extended - UpNode-Box-View - UpNode-Default - UpArray of Gutenberg blocks that make up the node body.
The item structure differs by API version:
Content schema: a top-level html field holds
rendered HTML and block-specific keys are spread flat alongside block_name and
inner_blocks.Content-V2 schema: the html field is removed
and all block-specific data is consolidated into a single attributes object.Node-Events-Box-View - UpNode-News-Box-View - UpNode-Sitemap-List-View - UpNode-Slider - UpNode-Teaser - UpNode-Type - UpNode-View-Mode - UpArray of Gutenberg blocks that make up the node body.
The item structure differs by API version:
Content schema: a top-level html field holds
rendered HTML and block-specific keys are spread flat alongside block_name and
inner_blocks.Content-V2 schema: the html field is removed
and all block-specific data is consolidated into a single attributes object.Node_Base_allOf_title - UpNode_Default_allOf_content - Upblock_name.
Common keys across many block types include text (normalised text content)
and url. Block types that embed other entities (e.g. piipe/linked-content-item,
piipe/distribution-box-item) include a nested node object exported in the
relevant view mode. Notification - UpNotification-Additional-Data - Uproute_1, route_2, route_3, …) — one per link found in the rendered notification text, in document order. The number of route keys is variable and unbounded.route_3, route_4, etc. Notifications-Settings - UpNotifications_Settings_notifications_inner - UpPerson-Widget-Item - UpPicture-Gallery-Post - UpPicture_Gallery_Post_author - UpPicture_Gallery_Post_author_picture - UpPicture_Gallery_Post_flag - UpPicture_Gallery_Post_permissions - UpPress_Article_Widget_inner - UpRoomResult - UpSearch-Facet - UpSearch-Result-Excerpt - UpSearch-Result-Node - UpSearch-Result-User - UpSearch_Facet_items_inner - UpSearch_Facet_items_inner_item_id - UpSearch_search_results_inner - UpSearch_sub_facets - UpSocial-Icons - UpSocial_Icons_comments - UpSocial_Icons_views - UpStatic-Box-Page - UpStatus-Message-Time-Settings - UpThread-Trace-Response - UpThumbnail - UpToolbar-Custom-Item - UpToolbar-Item-Base - UpToolbar-Item-Dictionary - UpToolbar-Item-Dictionary-Payload - UpToolbar-Item-Link - UpToolbar-Item-Link-Payload - UpToolbar-Item-Section - UpToolbar-Item-Section-Base - UpToolbar-Item-Subsection - UpToolbar-Settings-Object - UpToolbar_Default_Items_value - UpUpload-In-Progress - UpUser-Code-Register-Validation-Error - UpUser-Profile-Edit-Field - UpA profile field as returned by the edit endpoint GET. Extends the base field definition
with edit-specific properties: private, required, and optionally placeholder and
title_required.
Note on options format: for entity_reference (taxonomy) fields, options is an
array of { value, label } objects ordered by weight then name. For list_string and
language reference fields it is a keyed object (ID → label) as in User-Profile-Field-Base.
User-Profile-Edit-Image - UpUser-Profile-Edit-Patch-V1 - Updetails object.User-Profile-Edit-V1 - UpUser-Profile-Edit-V1-Profile - UpUser-Profile-Edit-V2 - UpUser-Profile-Edit-V2-Profile - UpUser-Profile-Edit-V2-Section - UpUser-Profile-Field-Base - UpUser-Profile-Org-Chart - UpUser-Profile-Section-Base - UpUser-Profile-V1-Profile - UpUser-Profile-V2-Field - UpUser-Profile-V2-Profile - UpUser-Profile-V2-Section - UpUser-Settings - UpUser-Settings-Element - UpUser-Settings-Section - UpUser_Profile_Edit_Field_allOf_placeholder - UpUser_Profile_Edit_Image_default - UpUser_Profile_Edit_Image_settings - UpUser_Profile_Field_Base_value - UpThe field value. Shape depends on the field type:
string, string_long, entity_reference (single): a string.entity_reference (multi): an array of strings.datetime: a formatted date string.link: an object with title and uri.image: a comma-separated string of file IDs.User_Settings_Element_data - UpVehicleResult - UpWho-s-new-Widget - Up_api_v1_piipe_picture_gallery_create_post_200_response - Up_api_v1_piipe_picture_gallery_create_post_request_chunk - Up_birthday_calendar_get_200_response - Up_box_pages__page_name__get_200_response - Up_box_pages_frontend_boxes_reorder_patch_request - Up_comment_post_request - Up_comment_post_request_allOf_entity_id_inner - Up_comment_post_request_allOf_field_subject_long_inner - Up_comment_post_request_allOf_pid_inner - Up_community_joining_request__gid__patch_request - Up_community_list_get_200_response - Up_community_members__gid__get_200_response - Up_community_post_request - Up_community_post_request_community_picture - Up_community_post_request_community_picture_value - Up_employee_jubilees_get_200_response - Up_employee_jubilees_get_200_response_employee_jubilees_allOf_inner - Up_event__type__get_200_response - Uptrue for overview responses. create event content permission. _new_colleagues_get_200_response - Up_piipe_comments_mention_post_request - Up_piipe_picture_gallery_patch_200_response - Up_piipe_picture_gallery_patch_200_response_oneOf - Up_piipe_picture_gallery_patch_request - Up_piipe_picture_gallery_patch_request_chunk - Up_piipe_picture_gallery_patch_request_chunk_post_data - Up_piipe_toolbar_custom_objects_patch_request - Up_piipe_toolbar_custom_objects_patch_request_objectsToBeUpdated_inner - Up_piipe_toolbar_custom_objects_post_request - Up_piipe_toolbar_settings_patch_request - Up_piipe_toolbar_settings_patch_request_objectsToBeUpdated_inner - Up_piipe_toolbar_settings_post_request - Up_register_device_token_post_400_response - Up_user_code_register_post_request - Up_user_login_post_202_response - Up_user_profile__uid__get_200_response - Up_user_profile_edit__uid__patch_200_response - Up_user_profile_edit__uid__patch_request_changes - Up_user_profile_edit__uid__patch_request_changes_editData - Up_user_profile_edit__uid__patch_request_changes_editData_image_value - Up_user_profile_edit__uid__patch_request_changes_editData_image_value_file - Up_user_profile_edit__uid__patch_request_changes_editData_profile - UpKeyed by field machine name. Each entry must include a value key
with the new value and optionally a private boolean.
Fields whose edit flag is 0 in the module config are silently
skipped — submitting them does not cause an error.
_user_profile_edit__uid__patch_request_changes_editData_profile_fields_value - Uphide flag is enabled in the module config;
otherwise silently ignored. _user_profile_edit__uid__patch_request_changes_editData_profile_fields_value_value - UpThe new field value. Shape depends on field type:
title and uri._user_register_post_request_field_firstname_inner - Up_user_register_post_request_field_lastname_inner - Up_user_register_post_request_mail_inner - Up_user_register_post_request_name_inner - Up_user_settings_patch_request - Up_wiki_term_overview__term_id__get_200_response - Up_wiki_term_overview__term_id__get_200_response_data_inner - Up