HumHub - Polls API (1.0.0)

Download OpenAPI specification:

Welcome to the HumHub polls module API reference.

Polls

Find all polls

query Parameters

page	integer >= 0 The number of page of the result set.
limit	integer [ 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": 4,
"contentcontainer_id": 2,
"question": "Poll question from API?",
"description": "Poll description from API",
"allow_multiple": 1,
"created_at": "2021-07-20 09:43:12",
"created_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"updated_at": "2021-07-20 09:43:12",
"updated_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"is_random": 1,
"closed": 1,
"anonymous": 0,
"show_result_after_close": 0,
"answers": [{"id": 1,
"poll_id": 4,
"answer": "First answer text",
"created_at": "2021-07-20 10:43:12",
"created_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"updated_at": "2021-07-20 10:43:12",
"updated_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
}
}
],
"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 polls by container

path Parameters

required

integer

ID of content container

query Parameters

page	integer >= 0 The number of page of the result set.
limit	integer [ 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": 4,
"contentcontainer_id": 2,
"question": "Poll question from API?",
"description": "Poll description from API",
"allow_multiple": 1,
"created_at": "2021-07-20 09:43:12",
"created_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"updated_at": "2021-07-20 09:43:12",
"updated_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"is_random": 1,
"closed": 1,
"anonymous": 0,
"show_result_after_close": 0,
"answers": [{"id": 1,
"poll_id": 4,
"answer": "First answer text",
"created_at": "2021-07-20 10:43:12",
"created_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"updated_at": "2021-07-20 10:43:12",
"updated_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
}
}
],
"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"
}
]
}
}
]
}

Delete polls by container

path Parameters

required

integer

The id of content container

Responses

Response samples

Content type

application/json

{"code": 200,
"message": "Records successfully deleted!"
}

Poll

Create new poll

path Parameters

required

integer

The id of content container

Request Body schema: application/json

Poll information

required	object
newAnswers required	Array of strings New answers
	object (Content)

Responses

Request samples

Payload

Content type

application/json

{"Poll": {"question": "New question from API?",
"description": "New description from API?",
"allow_multiple": 0,
"is_random": 1,
"anonymous": 0,
"show_result_after_close": 0
},
"newAnswers": ["First answer",
"Second answer",
"Third answer"
],
"content": {"metadata": {"visibility": 1,
"state": 1,
"archived": true,
"hidden": true,
"pinned": false,
"locked_comments": false,
"scheduled_at": "2023-09-14 05:15:00",
"created_at": "2022-04-13 05:15:43"
},
"topics": [{"name": "News"
}
]
}
}

Response samples

Content type

application/json

{"id": 4,
"contentcontainer_id": 2,
"question": "Poll question from API?",
"description": "Poll description from API",
"allow_multiple": 1,
"created_at": "2021-07-20 09:43:12",
"created_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"updated_at": "2021-07-20 09:43:12",
"updated_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"is_random": 1,
"closed": 1,
"anonymous": 0,
"show_result_after_close": 0,
"answers": [{"id": 1,
"poll_id": 4,
"answer": "First answer text",
"created_at": "2021-07-20 10:43:12",
"created_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"updated_at": "2021-07-20 10:43:12",
"updated_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
}
}
],
"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 a poll by id

path Parameters

required

integer

The id of the poll

Responses

Response samples

Content type

application/json

{"id": 4,
"contentcontainer_id": 2,
"question": "Poll question from API?",
"description": "Poll description from API",
"allow_multiple": 1,
"created_at": "2021-07-20 09:43:12",
"created_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"updated_at": "2021-07-20 09:43:12",
"updated_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"is_random": 1,
"closed": 1,
"anonymous": 0,
"show_result_after_close": 0,
"answers": [{"id": 1,
"poll_id": 4,
"answer": "First answer text",
"created_at": "2021-07-20 10:43:12",
"created_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"updated_at": "2021-07-20 10:43:12",
"updated_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
}
}
],
"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"
}
]
}
}

Update a poll by id

path Parameters

required

integer

The id of the poll

Request Body schema: application/json

Poll information

required	object
answers	Array of strings Updating answers
newAnswers required	Array of strings New answers
	object (Content)

Responses

Request samples

Payload

Content type

application/json

{"Poll": {"question": "New question from API?",
"description": "New description from API?",
"allow_multiple": 0,
"is_random": 1,
"anonymous": 0,
"show_result_after_close": 0
},
"answers": [{"1": "Updated first answer"
},
{"2": "Updated second answer"
},
{"3": "Updated third answer"
}
],
"newAnswers": ["Fourth answer",
"Fifth answer"
],
"content": {"metadata": {"visibility": 1,
"state": 1,
"archived": true,
"hidden": true,
"pinned": false,
"locked_comments": false,
"scheduled_at": "2023-09-14 05:15:00",
"created_at": "2022-04-13 05:15:43"
},
"topics": [{"name": "News"
}
]
}
}

Response samples

Content type

application/json

{"id": 4,
"contentcontainer_id": 2,
"question": "Poll question from API?",
"description": "Poll description from API",
"allow_multiple": 1,
"created_at": "2021-07-20 09:43:12",
"created_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"updated_at": "2021-07-20 09:43:12",
"updated_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"is_random": 1,
"closed": 1,
"anonymous": 0,
"show_result_after_close": 0,
"answers": [{"id": 1,
"poll_id": 4,
"answer": "First answer text",
"created_at": "2021-07-20 10:43:12",
"created_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"updated_at": "2021-07-20 10:43:12",
"updated_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
}
}
],
"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"
}
]
}
}

Delete a poll by id

path Parameters

required

integer

The id of the poll

Responses

Response samples

Content type

application/json

{"code": 200,
"message": "Successfully deleted!"
}

Poll management

Close a poll by id

path Parameters

required

integer

The id of the poll

Responses

Response samples

Content type

application/json

{"code": 200,
"message": "Poll has been successfully closed."
}

Open a poll by id

path Parameters

required

integer

The id of the poll

Responses

Response samples

Content type

application/json

{"code": 200,
"message": "Poll has been successfully reopened."
}

Poll voting

Vote on a poll by id

path Parameters

required

integer

The id of the poll

Request Body schema: application/json
required

answers

Array of integers

Selected answers

Responses

Request samples

Payload

Content type

application/json

{"answers": [1,
4
]
}

Response samples

Content type

application/json

{"code": 200,
"message": "You have voted."
}

Reset vote on a poll by id

path Parameters

required

integer

The id of the poll

Responses

Response samples

Content type

application/json

{"code": 200,
"message": "You have reset your vote."
}

Get votes on a poll for current user

path Parameters

required

integer

The id of the poll

Responses

Response samples

Content type

application/json

[[11,
13,
24
]
]

HumHub - Polls API (1.0.0)

Polls

Find all polls

query Parameters

Responses

Response samples

Find all polls by container

path Parameters

query Parameters

Responses

Response samples

Delete polls by container

path Parameters

Responses

Response samples

Poll

Create new poll

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get a poll by id

path Parameters

Responses

Response samples

Update a poll by id

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Delete a poll by id

path Parameters

Responses

Response samples

Poll management

Close a poll by id

path Parameters

Responses

Response samples

Open a poll by id

path Parameters

Responses

Response samples

Poll voting

Vote on a poll by id

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Reset vote on a poll by id

path Parameters

Responses

Response samples

Get votes on a poll for current user

path Parameters

Responses

Response samples

Request Body schema: application/json
required