List

Get a paginated list of knowledge base items

Headers

URL parameters

Example request

$ curl https://api.deskero.com/knowledgeItem/list \ 
	-v \
	-H "Accept: application/json" \
	-H "Authorization: Bearer 58cfg61g-1585-5c72-g35f-7fe76893ed2f" \
	-H "clientId: 51f01687e4b094c81d7b8bcdellef"

Example response

{
	"knowledge base": {
		"totalRecords": 50,
		"recordsPerPage": 25,
		"previousQuery": null,
		"nextQuery": "https://api.deskero.com/knowledgeItem/list?page=2",
		"records": [
			See knowledge base item detail
		]
	}
}

Search

Search a knowledge base item

Headers

URL parameters

Example request

$ curl https://api.deskero.com/knowledgeItem/list?item=Sign in\ 
	-v \
	-H "Accept: application/json" \
	-H "Authorization: Bearer 58cfg61g-1585-5c72-g35f-7fe76893ed2f" \
	-H "clientId: 51f01687e4b094c81d7b8bcdellef"

Example response

{
	"knowledge base": {
		"totalRecords": 1,
		"recordsPerPage": 25,
		"previousQuery": null,
		"nextQuery": null,
		"records": [
			See knowledge base item detail
		]
	}
}

Detail

Show a single knowledge base item

Headers

Example request

$ curl https://api.deskero.com/knowledgeItem/51cd8af3e4b0e90b324ab778 \ 
	-v \
	-H "Accept: application/json" \
	-H "Authorization: Bearer 58cfg61g-1585-5c72-g35f-7fe76893ed2f" \
	-H "clientId: 51f01687e4b094c81d7b8bcdellef"

Example response

{
	"id": "51b9d6b8e4b0d7cf068b9749",
	"title": "How do I log in?",
	"text": "To sign in all you have to do is inserting your email and your password, and that’s it!",
	"insertDate": 1372425039129,
	"views": 9,
	"insertBy": {
		See agent detail
	},
	"approved": true,
	"featured": true,
	"contributeBy": {
		See customer detail
	},
	"area": {
		See knowledge base area detail
	},
	"tags": [
		See tag detail
	],
	"attachedDocuments": [
		See attached document detail
	],
	"votesNumber": 5,
	"votesSum": 25,
	"score": 5
}

Create

Create a new knowledge base item

Headers

Example request

$ curl https://api.deskero.com/knowledgeItem/insert \ 
	-v \
	-H "Content-item: application/json" \
	-H "Authorization: Bearer 58cfg61g-1585-5c72-g35f-7fe76893ed2f" \
	-H "clientId: 51f01687e4b094c81d7b8bcdellef" \
	-X POST \
	-d '{
		"title":"How do I log in?",
		"text":"To sign in all you have to do is inserting your email and your password, and that’s it!",
		"area":{
			"id":"51cd8af3e4b0e90b324ab778"
		}
	}'

Example response

Created knowledge base item id

{
	"id": "51b9d6b8e4b0d7cf068b9749"
}

Update

Update a knowledge base item

Headers

Example request

$ curl https://api.deskero.com/knowledgeItem/update/51b9d6b8e4b0d7cf068b9749 \ 
	-v \
	-H "Content-item: application/json" \
	-H "Authorization: Bearer 58cfg61g-1585-5c72-g35f-7fe76893ed2f" \
	-H "clientId: 51f01687e4b094c81d7b8bcdellef" \
	-X PUT \
	-d '{
		"title":"How do I log in?",
		"text":"To sign in all you have to do is inserting your email and your password, and that’s it!",
		"area":{
			"id":"51cd8af3e4b0e90b324ab778"
		}
	}'

Example response

Updated knowledge base item id

{
	"id": "51b9d6b8e4b0d7cf068b9749"
}

Delete

Delete a knowledge base item

Headers

Example request

$ curl https://api.deskero.com/knowledgeItem/delete/51b9d6b8e4b0d7cf068b9749 \ 
	-v \
	-H "Content-item: application/json" \
	-H "Authorization: Bearer 58cfg61g-1585-5c72-g35f-7fe76893ed2f" \
	-H "clientId: 51f01687e4b094c81d7b8bcdellef" \
	-X DELETE

Example response

Deleted knowledge base item id

{
	"id": "51b9d6b8e4b0d7cf068b9749"
}

Fields