Exporting Users and Organizations Information Using API

Overview

There's no built-in feature in Kayako that would allow you to export users and organizations directly into a document file. However, you can use the API to retrieve the information in JSON format and convert the output as CSV or document file type using some online service.

Alternatively, you can Request a Data Dump or Backup for Your Kayako Instance which contains all your instance data including the users, organizations, cases, and more in a MySQL dump file format.

Prerequisites

• To retrieve users' and organizations' data using API, you will need to use an agent or admin user account.
• Skills and knowledge of API (Application Programming Interface) calls.
  
  

Solution

You may use an API tool or client (e.g., Postman) to perform the following steps or you may run the GET request directly from the browser.

Retrieve users' data

Use the following API call to get users' data (Replace DOMAIN with your actual Kayako instance domain):
GET https://DOMAIN.kayako.com/api/v1/users?include=*&fields=full_name,role,emails,organization.json

Retrieve organizations' data

Use the following API call to get organizations' data (Replace DOMAIN with your actual Kayako instance domain):
GET https://DOMAIN.kayako.com/api/v1/organizations.json

NOTE: By default, these calls will return a total of 10 results per page. However, you can add the limit argument to increase the number of results available per page as shown below (maximum is 100):
GET https://DOMAIN.kayako.com/api/v1/users?include=*&fields=full_name,role,emails,organization&limit=100.json
GET https://DOMAIN.kayako.com/api/v1/organizations&limit=100.json

Confirmation

The queries will return "status": 200 and result in JSON format as shown below:

{
"status": 200,
"data": [
{
"id": 1,
"name": "some NAME",
"legacy_id": null,
"is_shared": false,
"domains": [
{
"id": 5,
"resource_type": "identity_domain"
}
],
"is_validated": null,
"phone": [555],
"addresses": [some address],
"websites": [some site],
"pinned_notes_count": 0,
"custom_fields": [some custom fileds],
"created_at": "2020-10-30T06:17:01+00:00",
"updated_at": "2020-10-30T06:17:01+00:00",
"resource_type": "organization",
"resource_url": "https://DOMAIN.kayako.com/api/v1/organizations/1"
}
],
"resource": "organization",
"offset": 0,
"limit": 10,
"total_count": 1
}

You may use an application to convert the JSON format to a CSV or document file. We do not provide support for converting the output file to a different format.

Learn more about Kayako API, SDK, and other developer resources in our developer portal.