Developer's Guide

Learn how to configure and use our open APIs,
to freely integrate Deskero with any other software solution!

Knowledge Base groups

List

Get a paginated list of knowledge base groups

GET https://api.deskero.com/knowledgeGroup/list

Headers

Header	Value
Authorization	Bearer {{bearer}}
Accept	application/json
clientId	{{clientId}}

URL parameters

Field name	Value	Required	Default
page	int value for page to show	false	1

Example request

$ curl https://api.deskero.com/knowledgeGroup/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/knowledgeGroup/list?page=2",
		"records": [
			See knowledge base group detail
		]
	}
}

Search

Search a knowledge base group

GET https://api.deskero.com/knowledgeGroup/list

Headers

Header	Value
Authorization	Bearer {{bearer}}
Accept	application/json
clientId	{{clientId}}

URL parameters

Field name	Value	Required	Default
page	int value for page to show	false	1
{{fieldName}}	a value to search	false

Example request

$ curl https://api.deskero.com/knowledgeGroup/list?group=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 group detail
		]
	}
}

Detail

Show a single knowledge base group

GET https://api.deskero.com/knowledgeGroup/{{knowledgeBaseGroupId}}

Headers

Header	Value
Authorization	Bearer {{bearer}}
Accept	application/json
clientId	{{clientId}}

Example request

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

Example response

{
	"id": "52b423c3e4b04b021e45b660",
	"group": "24/7 Support",
	"insertDate": 1387537347269,
	"visibility": "ALL",
	"agentGroups": [
		See agent group detail
	],
	"customerCompanies": [
		See customer company detail
	],
	"knowledgeAreas": [
		See knowledge base area detail
	]
}

Create

Create a new knowledge base group

POST https://api.deskero.com/knowledgeGroup/insert

Headers

Header	Value
Authorization	Bearer {{bearer}}
Content-Type	application/json
clientId	{{clientId}}

Example request

$ curl https://api.deskero.com/knowledgeGroup/insert \ 
	-v \
	-H "Content-group: application/json" \
	-H "Authorization: Bearer 58cfg61g-1585-5c72-g35f-7fe76893ed2f" \
	-H "clientId: 51f01687e4b094c81d7b8bcdellef" \
	-X POST \
	-d '{
		"group": "24/7 Support",
		"visibility": "AGENT_GROUPS",
		"agentGroups" : [
			{
				"id": "52bd5c0de4b084c4b57bfe9a"
			}
		]
	}'

Example response

Created knowledge base group id

{
	"id": "52b423c3e4b04b021e45b660"
}

Update

Update a knowledge base group

PUT https://api.deskero.com/knowledgeGroup/update/{{knowledgeGroupId}}

Headers

Header	Value
Authorization	Bearer {{bearer}}
Content-Type	application/json
clientId	{{clientId}}

Example request

$ curl https://api.deskero.com/knowledgeGroup/update/52b423c3e4b04b021e45b660 \ 
	-v \
	-H "Content-group: application/json" \
	-H "Authorization: Bearer 58cfg61g-1585-5c72-g35f-7fe76893ed2f" \
	-H "clientId: 51f01687e4b094c81d7b8bcdellef" \
	-X PUT \
	-d '{
		"group": "24/7 Support",
		"visibility": "AGENT_GROUPS",
		"agentGroups" : [
			{
				"id": "52bd5c0de4b084c4b57bfe9a"
			}
		]
	}'

Example response

Updated knowledge base group id

{
	"id": "52b423c3e4b04b021e45b660"
}

Delete

Delete a knowledge base group

DELETE https://api.deskero.com/knowledgeGroup/delete/{{knowledgeGroupId}}

Headers

Header	Value
Authorization	Bearer {{bearer}}
Content-Type	application/json
clientId	{{clientId}}

Example request

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

Example response

Deleted knowledge base group id

{
	"id": "52b423c3e4b04b021e45b660"
}

Fields

Field name	Description
id	auto-generated id
group	unique group name
visibility	group visibility; admitted values: ALL, LOGGED, ONLY_AGENTS, AGENT_GROUPS, CUSTOMER_COMPANIES
knowledgeAreas	list of knowledge area, see knowledge area detail
agentGroups	required if visibility is AGENT_GROUPS, see agent group detail
customerCompanies	required if visibility is CUSTOMER_COMPANIES, see customer company detail