HumHub - Survey API (1.0.0)

Download OpenAPI specification:Download

E-mail: contact@cuzy.app License: AGPLv3 and CUZY.APP commercial licence

Welcome to the HumHub Survey module API reference.

Survey

Find all surveys

query Parameters

page	string >= 0 The number of page of the result set.
limit	string [ 1 .. 50 ] Default: 20 The numbers of items to return per page.

Responses

Response samples

Content type

application/json

{"total": 76,
"page": 1,
"results": [{"id": 201,
"title": "Some Survey title",
"description": "Some Survey description",
"schema": { },
"state": "Some Survey description",
"state_updated_at": "2022-02-27 00:00:00",
"restricted_to_group_ids": [3
],
"show_in_menu": 1,
"answers_visibility": "all",
"show_who_answered": "all",
"max_answers": 100,
"max_total_answers": 1000,
"edit_answer": 1,
"url_after_answering": "all",
"permalink": "http://localhost/content/perma?id=609",
"fields": [{"id": 2424,
"survey_id": 65,
"label": "The field label",
"name": "radio-group-1664958740482",
"type": "radio-group",
"visibility": "all",
"value": "Placeholder value",
"values": { },
"sort_order": 10
}
],
"content": {"metadata": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"object_model": "humhub\\modules\\post\\models\\Post",
"object_id": 12,
"visibility": 1,
"state": 1,
"archived": true,
"hidden": true,
"pinned": false,
"locked_comments": false,
"scheduled_at": "2023-09-14 05:15:00",
"created_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"created_at": "2022-04-13 05:15:43",
"updated_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"updated_at": "2022-05-21 06:20:18",
"url": "http://localhost/p/humhub/master/content/perma?id=109",
"contentcontainer_id": 5,
"stream_channel": "default"
},
"comments": {"total": 55,
"latestComments": [{"id": 14,
"message": "Calvin Klein – Between love and madness lies obsession.",
"objectModel": "humhub\\modules\\post\\models\\Post",
"objectId": 123,
"createdBy": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"createdAt": "2018-08-09 14:22:03",
"commentsCount": 5,
"comments": [{ }
]
}
]
},
"likes": {"total": 35
},
"files": {"id": 14,
"guid": "bded6dc7-e6f4-417e-a638-b653525529ca",
"mime_type": "text/plain",
"size": 14353,
"file_name": "image.jpg",
"url": "http://localhost/p/humhub/master/file/file/download?guid=bded6dc7-e6f4-417e-a638-b653525529ca"
},
"topics": [{"id": 135,
"name": "News"
}
]
}
}
]
}

Find all global surveys

The surveys in containers are excluded

query Parameters

page	string >= 0 The number of page of the result set.
limit	string [ 1 .. 50 ] Default: 20 The numbers of items to return per page.

Responses

Response samples

Content type

application/json

{"total": 76,
"page": 1,
"results": [{"id": 201,
"title": "Some Survey title",
"description": "Some Survey description",
"schema": { },
"state": "Some Survey description",
"state_updated_at": "2022-02-27 00:00:00",
"restricted_to_group_ids": [3
],
"show_in_menu": 1,
"answers_visibility": "all",
"show_who_answered": "all",
"max_answers": 100,
"max_total_answers": 1000,
"edit_answer": 1,
"url_after_answering": "all",
"permalink": "http://localhost/content/perma?id=609",
"fields": [{"id": 2424,
"survey_id": 65,
"label": "The field label",
"name": "radio-group-1664958740482",
"type": "radio-group",
"visibility": "all",
"value": "Placeholder value",
"values": { },
"sort_order": 10
}
],
"content": {"metadata": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"object_model": "humhub\\modules\\post\\models\\Post",
"object_id": 12,
"visibility": 1,
"state": 1,
"archived": true,
"hidden": true,
"pinned": false,
"locked_comments": false,
"scheduled_at": "2023-09-14 05:15:00",
"created_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"created_at": "2022-04-13 05:15:43",
"updated_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"updated_at": "2022-05-21 06:20:18",
"url": "http://localhost/p/humhub/master/content/perma?id=109",
"contentcontainer_id": 5,
"stream_channel": "default"
},
"comments": {"total": 55,
"latestComments": [{"id": 14,
"message": "Calvin Klein – Between love and madness lies obsession.",
"objectModel": "humhub\\modules\\post\\models\\Post",
"objectId": 123,
"createdBy": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"createdAt": "2018-08-09 14:22:03",
"commentsCount": 5,
"comments": [{ }
]
}
]
},
"likes": {"total": 35
},
"files": {"id": 14,
"guid": "bded6dc7-e6f4-417e-a638-b653525529ca",
"mime_type": "text/plain",
"size": 14353,
"file_name": "image.jpg",
"url": "http://localhost/p/humhub/master/file/file/download?guid=bded6dc7-e6f4-417e-a638-b653525529ca"
},
"topics": [{"id": 135,
"name": "News"
}
]
}
}
]
}

Find all surveys by container

path Parameters

required

integer

ID of content container

query Parameters

topics	string Example: topics=Music,Dancing Coma separated list of topics to filter
page	string >= 0 The number of page of the result set.
limit	string [ 1 .. 50 ] Default: 20 The numbers of items to return per page.

Responses

Response samples

Content type

application/json

{"total": 76,
"page": 1,
"results": [{"id": 201,
"title": "Some Survey title",
"description": "Some Survey description",
"schema": { },
"state": "Some Survey description",
"state_updated_at": "2022-02-27 00:00:00",
"restricted_to_group_ids": [3
],
"show_in_menu": 1,
"answers_visibility": "all",
"show_who_answered": "all",
"max_answers": 100,
"max_total_answers": 1000,
"edit_answer": 1,
"url_after_answering": "all",
"permalink": "http://localhost/content/perma?id=609",
"fields": [{"id": 2424,
"survey_id": 65,
"label": "The field label",
"name": "radio-group-1664958740482",
"type": "radio-group",
"visibility": "all",
"value": "Placeholder value",
"values": { },
"sort_order": 10
}
],
"content": {"metadata": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"object_model": "humhub\\modules\\post\\models\\Post",
"object_id": 12,
"visibility": 1,
"state": 1,
"archived": true,
"hidden": true,
"pinned": false,
"locked_comments": false,
"scheduled_at": "2023-09-14 05:15:00",
"created_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"created_at": "2022-04-13 05:15:43",
"updated_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"updated_at": "2022-05-21 06:20:18",
"url": "http://localhost/p/humhub/master/content/perma?id=109",
"contentcontainer_id": 5,
"stream_channel": "default"
},
"comments": {"total": 55,
"latestComments": [{"id": 14,
"message": "Calvin Klein – Between love and madness lies obsession.",
"objectModel": "humhub\\modules\\post\\models\\Post",
"objectId": 123,
"createdBy": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"createdAt": "2018-08-09 14:22:03",
"commentsCount": 5,
"comments": [{ }
]
}
]
},
"likes": {"total": 35
},
"files": {"id": 14,
"guid": "bded6dc7-e6f4-417e-a638-b653525529ca",
"mime_type": "text/plain",
"size": 14353,
"file_name": "image.jpg",
"url": "http://localhost/p/humhub/master/file/file/download?guid=bded6dc7-e6f4-417e-a638-b653525529ca"
},
"topics": [{"id": 135,
"name": "News"
}
]
}
}
]
}

Get survey by id

path Parameters

required

integer

The id of the survey

Responses

Response samples

Content type

application/json

{"id": 201,
"title": "Some Survey title",
"description": "Some Survey description",
"schema": { },
"state": "Some Survey description",
"state_updated_at": "2022-02-27 00:00:00",
"restricted_to_group_ids": [3
],
"show_in_menu": 1,
"answers_visibility": "all",
"show_who_answered": "all",
"max_answers": 100,
"max_total_answers": 1000,
"edit_answer": 1,
"url_after_answering": "all",
"permalink": "http://localhost/content/perma?id=609",
"fields": [{"id": 2424,
"survey_id": 65,
"label": "The field label",
"name": "radio-group-1664958740482",
"type": "radio-group",
"visibility": "all",
"value": "Placeholder value",
"values": { },
"sort_order": 10
}
],
"content": {"metadata": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"object_model": "humhub\\modules\\post\\models\\Post",
"object_id": 12,
"visibility": 1,
"state": 1,
"archived": true,
"hidden": true,
"pinned": false,
"locked_comments": false,
"scheduled_at": "2023-09-14 05:15:00",
"created_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"created_at": "2022-04-13 05:15:43",
"updated_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"updated_at": "2022-05-21 06:20:18",
"url": "http://localhost/p/humhub/master/content/perma?id=109",
"contentcontainer_id": 5,
"stream_channel": "default"
},
"comments": {"total": 55,
"latestComments": [{"id": 14,
"message": "Calvin Klein – Between love and madness lies obsession.",
"objectModel": "humhub\\modules\\post\\models\\Post",
"objectId": 123,
"createdBy": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"createdAt": "2018-08-09 14:22:03",
"commentsCount": 5,
"comments": [{ }
]
}
]
},
"likes": {"total": 35
},
"files": {"id": 14,
"guid": "bded6dc7-e6f4-417e-a638-b653525529ca",
"mime_type": "text/plain",
"size": 14353,
"file_name": "image.jpg",
"url": "http://localhost/p/humhub/master/file/file/download?guid=bded6dc7-e6f4-417e-a638-b653525529ca"
},
"topics": [{"id": 135,
"name": "News"
}
]
}
}

Survey Answers

Find all answers of a survey

path Parameters

surveyId

required

integer

ID of survey

query Parameters

page	string >= 0 The number of page of the result set.
limit	string [ 1 .. 50 ] Default: 20 The numbers of items to return per page.

Responses

Response samples

Content type

application/json

{"total": 76,
"page": 1,
"pages": 8,
"links": {"self": "{endpoint_path}?page=1&per-page=10",
"next": "{endpoint_path}?page=2&per-page=10",
"last": "{endpoint_path}?page=8&per-page=10"
},
"results": [{"id": 2424,
"survey_id": 145,
"state": "visible",
"created_at": "2022-02-27 00:00:00",
"updated_at": "2022-02-27 00:00:00",
"created_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"answerFields": [{"id": 2424,
"answer_id": 65,
"field_id": 65,
"field": {"id": 2424,
"survey_id": 65,
"label": "The field label",
"name": "radio-group-1664958740482",
"type": "radio-group",
"visibility": "all",
"value": "Placeholder value",
"values": { },
"sort_order": 10
},
"value": "string"
}
],
"likes": {"total": 35
},
"files": {"id": 14,
"guid": "bded6dc7-e6f4-417e-a638-b653525529ca",
"mime_type": "text/plain",
"size": 14353,
"file_name": "image.jpg",
"url": "http://localhost/p/humhub/master/file/file/download?guid=bded6dc7-e6f4-417e-a638-b653525529ca"
}
}
]
}

Answer

Get answer by id

path Parameters

required

integer

The id of the answer

Responses

Response samples

Content type

application/json

{"id": 2424,
"survey_id": 145,
"state": "visible",
"created_at": "2022-02-27 00:00:00",
"updated_at": "2022-02-27 00:00:00",
"created_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"answerFields": [{"id": 2424,
"answer_id": 65,
"field_id": 65,
"field": {"id": 2424,
"survey_id": 65,
"label": "The field label",
"name": "radio-group-1664958740482",
"type": "radio-group",
"visibility": "all",
"value": "Placeholder value",
"values": { },
"sort_order": 10
},
"value": "string"
}
],
"likes": {"total": 35
},
"files": {"id": 14,
"guid": "bded6dc7-e6f4-417e-a638-b653525529ca",
"mime_type": "text/plain",
"size": 14353,
"file_name": "image.jpg",
"url": "http://localhost/p/humhub/master/file/file/download?guid=bded6dc7-e6f4-417e-a638-b653525529ca"
}
}