1
2
3
4
5
6
7
8
9
client.data.get("loggedInUser").then (
    function(data) {
      // success operation
      // "data" is {loggedInUser: {‘available’: “true”, ... }}
    },
    function(error) {
      // failure operation
    }
    );

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
{
  "loggedInUser" : {
    "available": false,
    "available_since": "2017-04-18T05:27:05.000Z",
    "abilities":["manage_canned_responses","view_admin",.......],
    "contact": {
      "active": true,
      "avatar": null,
      "email": "rachel @freshdesk.com",
      "id": "6",
      "job_title": "Investigator",
      "language": "en",
      "mobile": null,
      "name": "Rachel",
      "phone": null,
      "time_zone": "chennai"
    },
  "created_at": "2017-03-06T07:53:08.000Z",
  "group_ids": [],
  "id": 6,
  "occasional": false,
  "role_ids": [],
  "signature": "<div dir="ltr"><p>rachel</p></div>",
  "ticket_scope": 1,
  "updated_at": "2017-05-10T05:56:20.000Z"
  }
}

1
2
3
4
5
6
7
8
9
client.data.get("domainName").then (
    function(data) {
      // success operation
      // "data" is {domainName: "sample.freshdesk.com"}
    },
    function(error) {
      // failure operation
    }
    );

1
https://sample.freshdesk.com

1
2
3
4
5
6
7
8
9
client.data.get("ticket").then (
    function(data) {
      // success output
      // data is {ticket: {"subject": "support needed for..",..}}
    },
    function(error) {
      // failure operation
    }
    );

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
{
  "ticket": {
    "attachments": [],
    "cc_emails": [],
    "company_id": 1,
    "created_at": "2017-04-12T06:05:56.000Z",
    "custom_fields": [{
      "custom_number": null,
      "custom_line1": " "
    }],
    "description": "<div>Some details on the issue ..</div>",
    "description_text": "Some details on the issue ...",
    "due_by": "2017-04-15T06:05:56.000Z",
    "email_config_id": 3,
    "fr_due_by": "2017-04-13T06:05:56.000Z",
    "fr_escalated": true,
    "fwd_emails ": ["ram@freshdesk.com", "diana@freshdesk.com"],
    "group_id": null,
    "id": 25,
    "is_escalated": true,
    "priority": 1,
    "priority_type": "Low",
    "product_id": null,
    "reply_cc_emails": [],
    "requester_id": 12,
    "responder_id": null,
    "source": 1,
    "source_type": "email",
    "spam ": false,
    "stats": {
      "agent_responded_at": null,
      "closed_at": "2017-04-19T08:39:41.000Z",
      "first_responded_at": null,
      "pending_since": null,
      "requester_responded_at": null,
      "resolved_at": "2017-04-19T08:39:41.000Z",
      "status_updated_at": "2017-04-19T08:39:41.000Z"
    },
    "status": 5,
    "status_type": " ",
    "subject": "Requesting refund",
    "survey_result": null,
    "tags": [],
    "to_emails": [],
    "type": null,
    "updated_at": "2017-04-19T08:39:41.000Z"
  }
}

1
2
3
4
5
6
7
8
9
client.data.get("contact").then (
    function(data) {
      //Success output
      //data: {contact: {"active": true, ...}}
    },
    function(error) {
      // failure operation
    }
    );

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
  "contact": {
    "active": true,
    "address": "221 B, Baker Street, London.",
    "avatar": [{
      "attachment_url": "<AVATAR_URL>",
      "content_type": "application/octet-stream",
      "created_at": "2015-08-28T10:27:58Z",
      "id": 9,
      "name": "lantern.png",
      "size": 13036,
      "thumb_url": "<THUMB_URL>",
      "updated_at": "2017-04-11T10:01:23Z"
    }],
    "description": "requesting refund",
    "email": "rachel @freshdesk.com",
    "id": 12,
    "is_agent": false,
    "job_title": "Investigator",
    "language": "en",
    "mobile": "999919191999999999",
    "name": "Rachel",
    "other_companies": [],
    "other_emails": ["Zoeybarn@freshdesk.com", "saul@freshdesk.com"],
    "phone": "",
    "tags": ["marketing", "sales"],
    "time_zone": "",
    "twitter_id": "1Ac345",
    "view_all_tickets": true
  }
}

1
2
3
4
5
6
7
8
9
client.data.get("email_config").then (
   function(data) {
     //Success output
     //data is {email_config : [{  }]}
   },
   function(error) {
     // failure operation
   }
   );

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
  "email_config": [
     {
      "id":"43000026147",
      "replyEmail":"support@winterwolf.freshdesk.com",
      "name":"winterwolf",
      "toEmail":"support@winterwolf.freshdesk.com",
      "primaryRole":true,
      "groupId":3,
      "productId":6
    },
    {
      "id":"42000026147",
      "replyEmail":"support2@winterwolf.freshdesk.com",
      "name":"winterwolf2",
      "toEmail":"support2@winterwolf.freshdesk.com",
      "primaryRole":false,
      "groupId":2,
      "productId":4
      },
      {
      "id":"42000026148",
      "replyEmail":"support3@winterwolf.freshdesk.com",
      "name":"winterwolf3",
      "toEmail":"support3@winterwolf.freshdesk.com",
      "primaryRole":false,
      "groupId":7,
      "productId":9
      }
   ]
}

1
2
3
4
5
6
7
8
9
10
11
12
13
client.data.get("email_config").then (
   function(data) {
     //Success output
     //data is {email_config : [{  }]}
     // now setValue method can be called to set the
     //filtered activeEmailConfigs like below
     client.interface.trigger("setValue", {id: "activeEmailConfig", value: ["42000026147", "42000026147"]});
     // where value array contains the list of filtered email config object ids
   },
   function(error) {
     // failure operation
   }
   );

1
client.interface.trigger("setValue", {id: "from", value: "rachel@freshdesk.com"})

1
2
3
4
5
6
7
8
9
client.data.get("requester").then (
    function(data) {
      //Success output
      //data: {requester: {"active": true, ...}}
    },
    function(error) {
      // failure operation
    }
    );

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
{
  "requester": {
    "active": true,
    "address": "221 B, Baker Street, London.",
    "avatar": [{
      "attachment_url": "<AVATAR_URL>",
      "content_type": "application/octet-stream",
      "created_at": "2015-08-28T10:27:58Z",
      "id": 9,
      "name": "lantern.png",
      "size": 13036,
      "thumb_url": "<THUMB_URL>",
      "updated_at": "2017-04-11T10:01:23Z"
    }],
    "created_at": "2017-03-21T09:29:28.000Z",
    "description": "requesting refund",
    "email": "rachel @freshdesk.com",
    "id": 12,
    "is_agent": false,
    "job_title": "Investigator",
    "language": "en",
    "mobile": "999919191999999999",
    "name": "Rachel",
    "other_companies": [],
    "other_emails": ["Zoeybarn@freshdesk.com", "saul@freshdesk.com"],
    "phone": "",
    "tags": ["marketing", "sales"],
    "time_zone": "",
    "twitter_id": "1Ac345",
    "updated_at": "2017 - 04 - 12 T06: 04: 52.000 Z",
    "view_all_tickets": true
  }
}

1
2
3
4
5
6
7
8
9
client.data.get("company").then (
    function(data) {
      //Success output
      //data: {company: {"name": "supernova", ...}}
    },
    function(error) {
      // failure operation
    }
    );

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "company": {
    "avatar": [{
      "attachment_url": "<AVATAR_URL>",
      "content_type": "application/octet-stream",
      "created_at": "2015-08-28T10:27:58Z",
      "id": 9,
      "name": "lantern.png",
      "size": 13036,
      "thumb_url": "<THUMB_URL>",
      "updated_at": "2017-04-11T10:01:23Z"
    }],
    "id": 12,
    "name": "Acme Corporation",
    "view_all_tickets": false
  }
}

1
2
3
4
5
6
7
8
9
client.data.get("group").then (
    function(data) {
      //Success output
      //data: {group: {"id": 2, ...}}
    },
    function(error) {
      // failure operation
    }
    );

1
2
3
4
5
6
7
{
  "group": {
    "agent_ids": [6, 8],
    "id": 7,
    "name": "Product Management"
  }
}

1
2
3
4
5
6
7
8
9
client.data.get("status_options").then (
  function(data) {
    //Success output
    //data: {status_options: ["open","resolved","closed","pending"]}
},
  function(error) {
    // failure operation
}
);

1
2
3
4
5
6
7
8
9
client.data.get("time_entry").then (
     function(data) {
       //Success output
       //data: {"time_entry": {"time_entries": [{ ...}]
     },
     function(error) {
       // failure operation
     }
     );

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
    "time_entry": {
      "time_entries": [{
        "billable": true,
        "note": "",
        "id": 48000097025,
        "timer_running": false,
        "agent_id": 48000013666,
        "ticket_id": 20,
        "company_id": 48000819888,
        "time_spent": 2,
        "executed_at": "2019-11-07T18:30:00Z",
        "start_time": "2019-11-07T19:06:39Z",
        "created_at": "2019-11-07T19:06:39Z",
        "updated_at": "2019-11-07T19:06:41Z"
      }]
    }
 }

1
2
3
4
5
6
7
8
9
client.data.get("contact").then (
    function(data) {
      //Success output
      //data: {contact: {"active": true, ...}}
    },
    function(error) {
      // failure operation
    }
    );

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
{
  "contact": {
    "active": true,
    "address": "221 B, Baker Street, London.",
    "avatar": [{
      "attachment_url": "<AVATAR_URL>",
      "content_type": "application/octet-stream",
      "created_at": "2015-08-28T10:27:58Z",
      "id": 9,
      "name": "lantern.png",
      "size": 13036,
      "thumb_url": "<THUMB_URL>",
      "updated_at": "2017-04-11T10:01:23Z"
    }],
    "created_at": "2017-03-21T09:29:28.000Z",
    "custom_fields": null,
    "description": "requesting refund",
    "email": "rachel @freshdesk.com",
    "id": 12,
    "is_agent": false,
    "job_title": "Investigator",
    "language": "en",
    "mobile": "999919191999999999",
    "name": "Rachel",
    "other_companies": [],
    "other_emails": ["Zoeybarn@freshdesk.com", "saul@freshdesk.com"],
    "phone": "",
    "tags": ["marketing", "sales"],
    "time_zone": "",
    "twitter_id": "1Ac345",
    "updated_at": "2017-04-12T06:04:52.000Z",
    "view_all_tickets": true
  }
}

1
2
3
4
5
6
7
8
9
client.data.get("company").then (
    function(data) {
      //Success output
      //data: {company: {"name": "Acme Corporation", ...}}
    },
    function(error) {
      // failure operation
    }
    );

1
2
3
4
5
6
{
  "company": {
    "id": 12,
    "name": "Acme Corporation"
  }
}