NAV

Introduction

The TeamWave API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side (though you should never expose your secret API key). This API reference provides information on available endpoints and how to interact with it. JSON is returned by all API responses, including errors, although our API libraries convert responses to appropriate language-specific objects.

Authentication

Authenticate your account when using the API by including your secret API key in the request. Your API keys carry many privileges, so be sure to keep them secret!

Get API Key

You can get your API key from your TeamWave Account Profile --> You --> API Key. Copy the API key.

Make an API Call

Sample Request

https://app.teamwave.com/api/crm/deals/{deal_id}?api_key=Your_API_Key&format=json
GET /api/crm/deals/{deal_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

To make an API call, use this key as url parameter or header parameter with the url of the API (http://app.teamwave.com/api/)

Add api_key=Your API Key to your API url link for requests (POST, PATCH, GET, PUT).

Status Codes

Our REST API uses the following status codes:

Status Code Meaning
200 Request OK
201 Resource created
400 Bad Request – Your request is bad
401 Unauthorized – Your API key is wrong
402 Failed request
403 Forbidden – requested is hidden for administrators only
404 Not Found – The specified item could not be found
50x Internal Server Error

Projects

Projects provides various project management related operations using the /projects resource and related sub-resources. Use projects for managing new projects and existing projects. You can also use sub-resources to get tasks, milestones, events, files, reports, timelog and notes related details.

Projects

Project Object

Sample Object 
{
   "id":280,
   "name":"Explore AdHome",
   "description":"This template will give you to create sample project",
   "logo":"https://twprofile.s3.amazonaws.com/logo.jpg",
   "owner":{
      "id":2,
      "name":"adhome",
      "domain":"adhome",
      "logo":null,
      "email":"sam@adhome.com",
      "tenant_domain":"adhome.com",
      "created_on":"2015-06-04",
      "default_currency":"USD",
      "default_currency_symbol":"$",
      "label_txt":null,
      "orgkey":"adhome",
      "status":"paying",
      "trial_end_on":"2016-07-07"
   },
   "clients":[

   ],
   "users":[
      537,
      3300,
      3692,
      3858,
      3633,
      491,
      493,
      58,
      4,
      8
   ],
   "is_trashed":false,
   "start_date":null,
   "end_date":null,
   "budget":0.0,
   "privacy_enabled":false,
   "permissions":{
      "can_add_messages":true,
      "can_delete_messages":true,
      "can_add_tasks":true,
      "can_delete_tasks":true,
      "can_add_milestones":true,
      "can_delete_milestones":true,
      "can_add_timelogs":true,
      "can_delete_timelogs":true,
      "can_add_files":true,
      "can_delete_files":true,
      "can_add_notebooks":true,
      "can_delete_notebooks":true,
      "can_add_events":true,
      "can_delete_events":true,
      "project":280,
      "is_active":true,
      "calendar_enabled":true,
      "messages_enabled":true,
      "tasks_enabled":true,
      "notes_enabled":true,
      "milestones_enabled":true,
      "files_enabled":true,
      "time_enabled":true
   },
   "last_updated":"2016-07-22T09:36:11.442229Z",
   "tasks_enabled":true,
   "created_by":8,
   "milestones_enabled":true,
   "messages_enabled":true,
   "files_enabled":true,
   "time_enabled":true,
   "notes_enabled":true,
   "calendar_enabled":true,
   "label_color":null,
   "label_txt":"Ex",
   "created_on":"2015-10-15T07:49:41.957253Z",
   "modified_on":"2015-10-15T07:49:43.119392Z",
   "resource_url":"/projects/280",
   "drive_access":null,
   "drop_box_access":null,
   "is_active":true,
   "owner_name":"adhome",
   "is_template":false,
   "creating":false,
   "tags":null
}
Attribute Description
id (integer) ID for the project
name (string) Name of the project
description (string) description for the project
logo (url string) logo url for the project logo
owner (object) owner details
clients (integer) clients ID’s
users (array) users(ID) involved with projects
is_trashed (boolean) if the project is trashed
start_date (string) starting date for the project
end_date (string) project end date
budget (integer) budget value
privacy_enabled (boolean) if privacy is enabled or not
permissions (object) array of all the permissions for the project
last_updated (string) last updated datetime
taskes_enabled (boolean) if the tasks are enabled for the project
created_by (integer) ID of the creator
milestones_enabled (boolean) Enable milestones
files_enabled (boolean) Files enabled or not
time_enabled (boolean) time enabled or not
notes_enabled (boolean) notes enabled or not
calendar_enabled (boolean) calendar enabled or not
label_color label text color
label_txt (string) label text characters
created_on (string) creation datetime
modified_on (string) modified datetime
resource_url (string) resource url link
drive_access drive access details
drop_box_access drop box access details
is_active (boolean) if the project is active or not
owner_name (string) Owner of the project
is_template (boolean) if the project is also a template in templates section
creating (boolean) if the project is under creation, it will be true. After creating, it will be false.
tags (string) tags given for the project.

Permissions Object

Following permission fields are set for the project.

Attrbute Description
can_add_messages (boolean) can add new messages
can_delete_messages (boolean) can delete messages
can_add_tasks (boolean) can add tasks
can_delete_tasks (boolean) can delete task
can_add_milestones (boolean) can add milestone
can_delete_milestones (boolean) can delete milestone
can_add_timelogs (boolean) can add timelog
can_delete_timelogs (boolean) can delete timelog
can_add_files (boolean) can add files
can_delete_files (boolean) can delete files
can_add_notebooks (boolean) can add notebook
can_delete_notebooks (boolean) can delete notebooks
can_add_events (boolean) can add events
can_delete_events (boolean) can delete events
project (integer) ID of the project
is_active (boolean) is the project active
calendar_enabled (boolean) calender enabled or not for the project
messages_enabled (boolean) messages enabled or not for the project
tasks_enabled (boolean) tasks enabled for the project or not
notes_enabled (boolean) notes are enabled for the project
milestones_enabled (boolean) milestones feature enable in the project
files_enabled (boolean) files are enabled for this project
time_enabled (boolean) time is enabled for the project

List all Projects

GET  api/projects HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

Create Project

POST  api/projects HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
    "name": "Explore AdHome",
    "description": "Unified Platform for Collaboration, Sales, 
    Marketing & Support",
    "logo": "https://twprofile.s3.amazonaws.com/image.jpg",
    "Invite_data": [11],
    "Invite_note": "I invite you to work with me on this project. 
    Please feel free to share ideas, participate in discussions and give feedback. ",
    "label_txt": "Ex",
    "new_invite_data": [ ],
    "share_data": null,
    "share_note": "We invite you to collaborate with us on AdHome 
    for this project. We use AdHome to manage tasks, share ideas and discuss issues.",
    "share_type": "c"
}
Attribute Description
name (string) Name of the project
description (string) Description of the project
logo (string) Logo url of the project
Invite_data (array) List of user who already exists in the organization
Invite_note (string) Invite message to be send to the invited user’s email
label_txt (string) Label text of the project
new_invite_data (array) New email ids to be invited to the project
share_data (string) client’s email id . eg.,john@casio.com
share_note (string) shared message to be send to the client’s email
share_type (string) ((‘C’, 'Client’), ('V’, 'Vendor’), ('O’, 'Other’))

List all Projects

GET  api/projects HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
[
   {
      "id":280,
      "name":"Explore AdHome",
      "description":"This template will give you to create sample project",
      "logo":"https://twprofile.s3.amazonaws.com/image.jpg",
      "label_color":null,
      "tags":null,
      "owner_id":2,
      "label_txt":"Ex",
      "resource_url":"/projects/280",
      "last_updated":"2016-07-22T09:36:11.442229Z",
      "is_active":true,
      "owner_name":"adhome",
      "creating":false
   },
   {
      "id":253,
      "name":"AdHome",
      "description":"Unified Platform for Collaboration, Sales, Marketing & Support",
      "logo":"https://twprofile.s3.amazonaws.com/image.jpg",
      "label_color":"#9da2a6",
      "tags":{
         "28":{
            "color":"label-color-6",
            "tag":"AdHome"
         }
      },
      "owner_id":2,
      "label_txt":"Te",
      "resource_url":"/projects/253",
      "last_updated":"2016-07-22T08:09:24.534065Z",
      "is_active":true,
      "owner_name":"adhome",
      "creating":false
   }
]
Attribute Description
Id (integer) Identification number of the project
name (string) Name of the project
description (string) Description of the project
logo (uel string) Logo of the project
label_txt (string) Label text for the project
owner_id owner of the project
resource_url (url string) project access url
last_updated (date string) Last updated time of the project
owner_name (string) Project’s organization Name
creating (boolean) status whether the project is still creating by the celery or not. If it is still creating, the status is True else false

Task Group

Sample Object
{
   "id":901,
   "name":"Customer Issues",
   "description":"This will contain all the issues reported by customers.",
   "milestones":{
      "id":384,
      "title":"Customer issue completely fixed",
      "start":"2016-08-02",
      "resource_url":"/projects/565/milestones/384",
      "modified_on":"2016-07-21T05:48:56.164094Z"
   },
   "created_on":"2016-07-21T05:49:43.007788Z",
   "resource_url":"/projects/565/taskgroups/901",
   "created_by":{
      "id":1,
      "first_name":"Sathish",
      "last_name":"Venkat",
      "label_txt":"SV",
      "is_crm_enabled":true,
      "is_crm_admin":true,
      "is_pm_enabled":true,
      "is_hrm_admin":true,
      "corp_email":true,
      "organization":{
         "id":1,
         "name":"adhome",
         "domain":"adhome",
         "logo":"https://twprofile.s3.amazonaws.com/logo.jpg",
         "email":"sathish@adhome.com",
         "tenant_domain":"adhome.com",
         "created_on":"2015-03-07",
         "default_currency":"USD",
         "default_currency_symbol":"$",
         "label_txt":null,
         "orgkey":"adhomemediaindiapvtltd",
         "status":"paying",
         "trial_end_on":"2016-07-07"
      },
      "image":"https://twprofile.s3.amazonaws.com/image.jpg",
      "email":"sathish@adhome.com",
      "full_name":"Sathish Venkat",
      "is_owner":true,
      "is_admin":true,
      "is_active":true,
      "last_login":"2016-07-21T06:33:10.384807Z",
      "job_title":"Product Engineer",
      "time_zone":"Europe/Kaliningrad",
      "uuid":"dda0c7e8e1ed4231a2794c99d19be85b",
      "country":null,
      "is_noticeboard_enabled":true,
      "is_user_directory_enabled":true
   },
   "modified_by":{
      "id":1,
      "first_name":"Sathish",
      "last_name":"Venkat",
      "label_txt":"SV",
      "is_crm_enabled":true,
      "is_crm_admin":true,
      "is_pm_enabled":true,
      "is_hrm_admin":true,
      "corp_email":true,
      "organization":{
         "id":1,
         "name":"adhome",
         "domain":"adhome",
         "logo":"https://twprofile.s3.amazonaws.com/logo.jpg",
         "email":"sathish@adhome.com",
         "tenant_domain":"adhome.com",
         "created_on":"2015-03-07",
         "default_currency":"USD",
         "default_currency_symbol":"$",
         "label_txt":null,
         "orgkey":"adhomemediaindiapvtltd",
         "status":"paying",
         "trial_end_on":"2016-07-07"
      },
      "image":"https://twprofile.s3.amazonaws.com/image.jpg",
      "email":"sathish@adhome.com",
      "full_name":"Sathish Venkat",
      "is_owner":true,
      "is_admin":true,
      "is_active":true,
      "last_login":"2016-07-21T06:33:10.384807Z",
      "job_title":"Product Engineer",
      "time_zone":"Europe/Kaliningrad",
      "uuid":"dda0c7e8e1ed4231a2794c99d19be85b",
      "country":null,
      "is_noticeboard_enabled":true,
      "is_user_directory_enabled":true
   },
   "modified_on":"2016-07-21T06:00:02.519776Z",
   "is_trashed":false,
   "tasks":[
      {
         "name":"Important - Monitoring Third-party Services1",
         "index":1,
         "id":3164,
         "assigned_to":{
            "id":273,
            "first_name":"Rajdeep",
            "last_name":"Sharma",
            "label_txt":"RS",
            "is_crm_enabled":true,
            "is_crm_admin":false,
            "is_pm_enabled":true,
            "is_hrm_admin":false,
            "corp_email":false,
            "organization":{
               "id":1,
               "name":"adhome",
               "domain":"adhome",
               "logo":"https://twprofile.s3.amazonaws.com/logo.jpg",
               "email":"sathish@adhome.com",
               "tenant_domain":"adhome.com",
               "created_on":"2015-03-07",
               "default_currency":"USD",
               "default_currency_symbol":"$",
               "label_txt":null,
               "orgkey":"adhomemediaindiapvtltd",
               "status":"paying",
               "trial_end_on":"2016-07-07"
            },
            "image":null,
            "email":"rjdp9736@gmail.com",
            "full_name":"Rajdeep Sharma",
            "is_owner":false,
            "is_admin":false,
            "is_active":true,
            "last_login":"2016-06-22T06:55:34.531894Z",
            "job_title":"Dev",
            "time_zone":"Asia/Kolkata",
            "uuid":"6f85ece234da4fc6809841e93f2106bb",
            "country":"US",
            "is_noticeboard_enabled":true,
            "is_user_directory_enabled":true
         },
         "due_date":"2016-07-29",
         "completed_by":null,
         "modified_by":null,
         "created_by":{
            "id":1,
            "first_name":"Sathish",
            "last_name":"Venkat",
            "label_txt":"SV",
            "is_crm_enabled":true,
            "is_crm_admin":true,
            "is_pm_enabled":true,
            "is_hrm_admin":true,
            "corp_email":true,
            "organization":{
               "id":1,
               "name":"adhome",
               "domain":"adhome",
               "logo":"https://twprofile.s3.amazonaws.com/logo.jpg",
               "email":"sathish@adhome.com",
               "tenant_domain":"adhome.com",
               "created_on":"2015-03-07",
               "default_currency":"USD",
               "default_currency_symbol":"$",
               "label_txt":null,
               "orgkey":"adhomemediaindiapvtltd",
               "status":"paying",
               "trial_end_on":"2016-07-07"
            },
            "image":"https://twprofile.s3.amazonaws.com/image.jpg",
            "email":"sathish@adhome.com",
            "full_name":"Sathish Venkat",
            "is_owner":true,
            "is_admin":true,
            "is_active":true,
            "last_login":"2016-07-21T06:33:10.384807Z",
            "job_title":"Product Engineer",
            "time_zone":"Europe/Kaliningrad",
            "uuid":"dda0c7e8e1ed4231a2794c99d19be85b",
            "country":null,
            "is_noticeboard_enabled":true,
            "is_user_directory_enabled":true
         },
         "estimate":0,
         "completed_date":null,
         "is_completed":false,
         "timelog":"0:00",
         "created_on":"2016-07-21T06:10:31.053920Z",
         "modified_on":"2016-07-21T06:10:31.239412Z",
         "taskgroup_is_private":true,
         "project_name":"DQNC Inc.",
         "project_id":565,
         "tags":null,
         "taskgroup_name":"Customer Issues",
         "taskgroup_id":901,
         "taskgroup_is_trashed":false,
         "is_trashed":false,
         "comment_count":0,
         "resource_url":"/projects/565/taskgroups/901/tasks/3164",
         "tmp_due_date":null,
         "attachments":[
            3781
         ],
         "attachments_detail":[
            {
               "id":3781,
               "title":"canceled.png",
               "attachment":"https://mediatw.s3.amazonaws.com/projects/565/1469081412471_canceled.png?Signature=LcpcsUDJm5vcDqy0kWl%2Fqsq90uk%3D&Expires=1469086474&AWSAccessKeyId=AKIAJ3XCFVTYA",
               "object_id":3164,
               "is_drivebox":false,
               "is_trashed":false,
               "modified_by":null,
               "project":565,
               "size":"42817",
               "for_comment":false,
               "content_object_detail":{
                  "display_name":"Important - Monitoring Third-party Services1",
                  "url":"/projects/565/taskgroups/901/tasks/3164",
                  "group_name":"Customer Issues",
                  "group_url":"/projects/565/taskgroups/901",
                  "group_id":"901",
                  "id":"3164"
               },
               "created_by":{
                  "id":1,
                  "first_name":"Sathish",
                  "last_name":"Venkat",
                  "label_txt":"SV",
                  "is_crm_enabled":true,
                  "is_crm_admin":true,
                  "is_pm_enabled":true,
                  "is_hrm_admin":true,
                  "corp_email":true,
                  "organization":{
                     "id":1,
                     "name":"adhome",
                     "domain":"adhome",
                     "logo":"https://twprofile.s3.amazonaws.com/logo.jpg",
                     "email":"sathish@adhome.com",
                     "tenant_domain":"adhome.com",
                     "created_on":"2015-03-07",
                     "default_currency":"USD",
                     "default_currency_symbol":"$",
                     "label_txt":null,
                     "orgkey":"adhomemediaindiapvtltd",
                     "status":"paying",
                     "trial_end_on":"2016-07-07"
                  },
                  "image":"https://twprofile.s3.amazonaws.com/image.jpg",
                  "email":"sathish@adhome.com",
                  "full_name":"Sathish Venkat",
                  "is_owner":true,
                  "is_admin":true,
                  "is_active":true,
                  "last_login":"2016-07-21T06:33:10.384807Z",
                  "job_title":"Product Engineer",
                  "time_zone":"Europe/Kaliningrad",
                  "uuid":"dda0c7e8e1ed4231a2794c99d19be85b",
                  "country":null,
                  "is_noticeboard_enabled":true,
                  "is_user_directory_enabled":true
               },
               "created_on":"2016-07-21T06:10:16.516429Z",
               "is_live":true,
               "thumbnail":"https://mediatw.s3.amazonaws.com/projects/565",
               "comment_count":0,
               "modified_on":"2016-07-21T06:10:31.077537Z",
               "is_shared":false,
               "shared_note":null,
               "content_type":"task",
               "ext":"png",
               "resource_url":"/projects/565/files/3781",
               "download_url":"https://app.goAdHome.com/api/projects/565/files/download/3781",
               "is_private":false,
               "tgs":null
            }
         ]
      }
   ],
   "index":3,
   "total":1,
   "completed":0,
   "incompleted":1,
   "comment_count":0,
   "is_private":true,
   "default_asignee":null,
   "default_duedays":8
}
Attribute Description
id (integer) identification number of the task group
name (string) Name of the Task Group,
description (string) Description of the Task Group,
milestones (object) Milestones object related with this Task Group
created_on (date) Task group created date,
resource_url (string) Taskgroup detail page access url,
created_by (object) User object who created the task group,
modified_by (object) User object who modified the task group,
modified_on (date) Task group modified date,
is_trashed (boolean) Task group trashed status whether it is deleted or not,
tasks (list of objects) List of Tasks belonging to the Task Group,
index (integer) index no of the task group,
total (integer) Total no of task belongs to the task group,
completed (integer) No of completed tasks,
incompleted (integer) No of incomplete tasks,
comment_count (integer) No of comments for the task group,
is_private (boolean) Status of the Task Group. If it is True ,this task group won’t be visible to shared people. Default the value is False,
default_asignee (object) user object who is assigned for this task group,
default_duedays (integer) no of duedays given for the particular Task Group

Milestones Object

Attribute Description
id (integer) Identification number of the milestones,
title (string) Name of the Task Group,
start (date) Milestones start date,
resource_url (string) Milestones detail page access url,
modified_on (date) Milestones modified date

PM User Object

Attribute Description
id (integer) Identification number of the User,
first_name (string) First name of the User,
last_name (string) last_name of the User,
label_txt (string) label_txt of the User,
is_crm_enabled (string) Status to identify user can access the CRM module,
is_crm_admin (string) Status to identify user is CMR admin,
is_pm_enabled (string) Status to identify user can access the PM module,
is_hrm_admin (string) Status to identify user is HRM admin,
corp_email (string) Status to identify user has corporate email id,
organization (object) Organization object id of the User,
image (string) User profile image,
email (email id) Email id of the User,
full_name (string) First name of the User,
is_owner (boolean*) Status to identify user is owner or not,
is_admin (boolean) Status to identify user is PM admin or not,
is_active (boolean) Status to identify user is active or not,
last_login (datetime) User’s last login datetime,
job_title (string) User’s job title,
time_zone (string) User’s time_zone,
uuid (string) User’s Unique Identification number,
country (string) User’s country,
is_noticeboard_enabled (boolean) Status to identify user can access the noticeboard( in app notification) or not,
is_user_directory_enabled (boolean) Status to identify user can view the employees directory (in hrm ) or not

PM Organization Object

Attribute Description
id (integer) Identification number of the Organization,
name (string) Name of the Organization,
domain (string) DomainName of the Organization,
logo(url) Logo url of the Organization,
email (email) Email given to the Organization,
tenant_domain (string) Tenant_domain of the Organization,
created_on (date) Organization created date,
default_currency (string) Default Currency of the Organization,
default_currency_symbol (string) Default Currency symbol of the Organization,
label_txt (string) Label text of the Organization,
orgkey (string) Organization key,
status (string) Status of the organization . eg,.paying,
trial_end_on (date) Date on which AdHome account will end.

Create Task Group

POST /api/projects/{project_id}/taskgroups HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
    "name":"Customer Issues",
    "description":"This will contain all the issues reported by customers.",
    "is_private":true,
    "default_asignee_id":273,
    "default_duedays":8,
    "milestones":
            {
              "id":384
            }
}

Update Task Group

PATCH /api/projects/{project_id}/taskgroups/{task_group_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
        "id":901,
        "name":"Customer Issues",
        "description":"This will contain all the issues reported by customers.",
        "is_private":true,
        "default_asignee_id":273,
        "default_duedays":8,
        "milestones":
            {
                "id":384
            }
     }

List all Task Groups

Task

Task Object

{
    "name": "Important - Monitoring Third-party Services",
    "index": 0,
    "id": 5403,
    "assigned_to": {
        "id": 11,
        "first_name": "aravind",
        "last_name": "dsSpring",
        "label_txt": "ad",
        "is_crm_enabled": false,
        "is_crm_admin": false,
        "is_pm_enabled": true,
        "is_hrm_admin": false,
        "corp_email": true,
        "organization": {
            "id": 1,
            "name": "Dsqqqqqqq ds 2123",
            "domain": "adhome",
            "logo": "https://twprofile.s3.amazonaws.com/image.jpeg",
            "email": "geo.jacob@adhome.com",
            "tenant_domain": "adhome.com",
            "created_on": "2015-03-10",
            "default_currency": "USD",
            "default_currency_symbol": "$",
            "label_txt": null,
            "orgkey": "Dsq",
            "status": "paying",
            "trial_end_on": "2016-07-07"
        },
        "image": null,
        "email": "aravind@adhome.com",
        "full_name": "aravind dsSpring",
        "is_owner": false,
        "is_admin": false,
        "is_active": true,
        "last_login": "2016-07-22T06:26:52.720693Z",
        "job_title": "Developer",
        "time_zone": "Asia/Kolkata",
        "uuid": "340aec4d05984fa880a915c6c72ea794",
        "country": null,
        "is_noticeboard_enabled": false,
        "is_user_directory_enabled": true
    },
    "due_date": "2016-07-27",
    "completed_by": null,
    "modified_by": null,
    "created_by": {
        "id": 1,
        "first_name": "sathish",
        "last_name": "",
        "label_txt": "s",
        "is_crm_enabled": true,
        "is_crm_admin": true,
        "is_pm_enabled": true,
        "is_hrm_admin": true,
        "corp_email": true,
        "organization": {
            "id": 1,
            "name": "Dsqqqqqqq ds 2123",
            "domain": "adhome",
            "logo": "https://twprofile.s3.amazonaws.com/image.jpeg",
            "email": "geo.jacob@adhome.com",
            "tenant_domain": "adhome.com",
            "created_on": "2015-03-10",
            "default_currency": "USD",
            "default_currency_symbol": "$",
            "label_txt": null,
            "orgkey": "Dsq",
            "status": "paying",
            "trial_end_on": "2016-07-07"
        },
        "image": "https://twprofile.s3.amazonaws.com/image.jpg",
        "email": "sathish@adhome.com",
        "full_name": "sathish ",
        "is_owner": true,
        "is_admin": true,
        "is_active": true,
        "last_login": "2016-07-22T06:28:01.261390Z",
        "job_title": "Developer",
        "time_zone": "Asia/Kolkata",
        "uuid": "7452387e2f1d4eda952cb12ffbefb6b1",
        "country": null,
        "is_noticeboard_enabled": true,
        "is_user_directory_enabled": true
    },
    "estimate": 0,
    "completed_date": null,
    "is_completed": false,
    "timelog": "4:30",
    "created_on": "2016-07-22T06:24:35.156302Z",
    "modified_on": "2016-07-22T06:24:35.660229Z",
    "taskgroup_is_private": false,
    "project_name": "Pro_11",
    "project_id": 1190,
    "tags": null,
    "taskgroup_name": "Customer Issues",
    "taskgroup_id": 1569,
    "taskgroup_is_trashed": false,
    "is_trashed": false,
    "comment_count": 0,
    "resource_url": "/projects/1190/taskgroups/1569/tasks/5403",
    "tmp_due_date": null,
    "attachments": [],
    "attachments_detail": []
}
Attribute Description
name (string) Name of the Task
index (integer) index no of the Task
id (integer) Identification number of the Task
assigned_to (object) assign a user for this task to complete
due_date (data) duedate for the particular task
completed_by (object) user who completed the task
modified_by (object) user who modified the task
created_by (object) user who created the task
estimate (integer) estimate cost for the task
completed_date (date) completed date of the task
is_completed (boolean) Status to identify task is completed or not
timelog (date) time log for the particular task
created_on (date) task created date
modified_on (date) date on which the task is modified
taskgroup_is_private (boolean) Status to check taskgroup is private or not
project_name (string) Name of the project
project_id (integer) Id of the project
tags (array) Tags belongs to the task
taskgroup_name (string) Name of the taskgroup
taskgroup_id (integer) Id of the taskgroup
taskgroup_is_trashed (boolean) Status to check taskgroup is trashed or not
is_trashed (boolean) Status to check task is trashed or not
comment_count (integer) No of comments for the task
resource_url (string) Task detail page access url
tmp_due_date (date) Temporary due date for the task
attachments (array) Attachments object id like fileimage belongs to the task
attachments_detail (array of object) Details of the attachments belonging to the task

Attachments Detail

Attribute Description
id (integer) Identification number of the attachment
title (string) Name of the attachment
attachment (string) URL of the attachment
object_id (integer) id of the task
is_drivebox (boolean) Status to check attachment is from drivebox(google drive or drop box) or not
is_trashed (boolean) Status to check attachment is trashed or not
modified_by (object) user object who modified the attachment
project (integer) Id of the project
size (string) Size of the attachment
for_comment (boolean) Status to check attachment is for comments or not
content_object_detail (object) Detail of the content_object
created_by (object) user who created the attachment
created_on (date) date on which the attachment is created
is_live (boolean) Status to check attachment is live or not
thumbnail (string) URL of the attachment’s thumbnail
comment_count(inr) Comment count of the attachment’s thumbnail
modified_on (date) date on which the attachment is modified
is_shared (boolean) Status to check attachment is shared or not
shared_note (string) Shared note of the attachment
content_type (string) Content type of the attachment. eg.task
ext (string) Extension type of the attachment
resource_url (string) Attachments detail page access url
download_url (string) URL to download the attachment
is_private (boolean) Status to check attachment is private or not
tags (array) tags belongs to the attachment.

Content Object Detail

Attribute Description
display_name (string) Display name of the content object
url (string) URL to access the task detail page
group_name (string) Task group name
group_url (string) Task group’s URL
group_id (integer) Id of the Task group
id"(integer) Id of the task.

Create Task

POST   api/projects/{project_id}/taskgroups/{task_group_id}/tasks HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
Sample Request
{
    "name":"Important - Monitoring Third-party Services",
    "taskgroup_id":901,
    "due_date":"2016-07-29",
    "assigned_to":{"id":273},
    "attachment":[3781]
}

Retrieve Task

GET  api/projects/{project_id}/taskgroups/{task_group_id}/tasks/{task_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

Returns

If the call succeeds, the task object will be returned.

Update Task

PATCH  api/projects/{project_id}/taskgroups/{task_group_id}/tasks/{task_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
    "name":"Important - Monitoring Third-party Services",
    "assigned_to":
        {
            "id":273
        },
    "due_date":"2016-07-29",
    "attachment":[3781],
    "estimate":0
}

Returns

If call succeeds, the task object will be returned.

Delete Task

DELETE  api/projects/{project_id}/taskgroups/{task_group_id}/tasks/{task_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

Files

{
    "id": 4412,
    "title": "images_006.jpeg",
    "attachment": "https://mediatw.s3.amazonaws.com/projects/1190/1469097342438_images_006.jpeg?Signature=ZiE9Qvf1LK%2BxA4gxNkLrx4%2Bzx8c%3D&Expires=1469100966&AWSAccessKeyId=AKIAJ3L5LCTCJXCFVTYA",
    "object_id": null,
    "is_drivebox": false,
    "is_trashed": false,
    "modified_by": null,
    "project": 1190,
    "size": "7114",
    "for_comment": false,
    "content_object_detail": {},
    "created_by": {
        "id": 1,
        "first_name": "sathish",
        "last_name": "",
        "label_txt": "s",
        "is_crm_enabled": true,
        "is_crm_admin": true,
        "is_pm_enabled": true,
        "is_hrm_admin": true,
        "corp_email": true,
        "organization": {
            "id": 1,
            "name": "Dsqqqqqqq ds 2123",
            "domain": "adhome",
            "logo": "https://twprofile.s3.amazonaws.com/logo.jpeg",
            "email": "geo.jacob@adhome.com",
            "tenant_domain": "adhome.com",
            "created_on": "2015-03-10",
            "default_currency": "USD",
            "default_currency_symbol": "$",
            "label_txt": null,
            "orgkey": "Dsq",
            "status": "paying",
            "trial_end_on": "2016-07-07"
        },
        "image": "https://twprofile.s3.amazonaws.com/image.jpg",
        "email": "sathish@adhome.com",
        "full_name": "sathish ",
        "is_owner": true,
        "is_admin": true,
        "is_active": true,
        "last_login": "2016-07-21T06:24:04.037715Z",
        "job_title": "Developer",
        "time_zone": "Asia/Kolkata",
        "uuid": "7452387e2f1d4eda952cb12ffbefb6b1",
        "country": null,
        "is_noticeboard_enabled": true,
        "is_user_directory_enabled": true
    },
    "created_on": "2016-07-21T10:35:48.556209Z",
    "is_live": true,
    "thumbnail": null,
    "comment_count": 0,
    "modified_on": "2016-07-21T10:35:48.556252Z",
    "is_shared": false,
    "shared_note": null,
    "content_type": null,
    "ext": "jpeg",
    "resource_url": "/projects/1190/files/4412",
    "download_url": "http://192.168.1.51:9002/projects/1190/files/download/4412",
    "is_private": false,
    "tgs": null
}       
Attribute Description
id (integer) Identification number of the attachment,
title (string) Name of the attachment,
attachment (string) URL of the attachment,
object_id (integer) id of the task,
is_drivebox (boolean) Status to check attachment is from drivebox(google drive or drop box) or not,
is_trashed (boolean) Status to check attachment is trashed or not,
modified_by (object) user object who modified the attachment,
project (integer) Id of the project,
size (string) Size of the attachment,
for_comment (boolean) Status to check attachment is for comments or not,
content_object_detail (object) Detail of the content_object,
created_by (object) user who created the attachment,
created_on (date) date on which the attachment is created,
is_live (boolean) Status to check attachment is live or not,
thumbnail (string) URL of the attachment’s thumbnail,
comment_count(inr) Comment count of the attachment’s thumbnail,
modified_on (date) date on which the attachment is modified,
is_shared (boolean) Status to check attachment is shared or not,
shared_note (string) Shared note of the attachment,
content_type (string) Content type of the attachment. eg,.task,
ext (string) Extension type of the attachment,
resource_url (string) Attachments detail page access url,
download_url (string) URL to download the attachment,
is_private (boolean) Status to check attachment is private or not,
tags (array) tags belongs to the attachment.

Create File

POST /api/projects/{project_id}/files HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
    "status":"A",
    "title":"images_002.jpeg",
    "attachment":"http://amazons.com/projects/1190/1469097941615_images_002.jpeg",
    "ext":"jpeg",
    "project":"1190",
    "file_size":8773
}

Activate File

PATCH /api/projects/{project_id}/files/activate HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
Sample Response
{
    "ids":[4413],
    "is_private":false
}

Delete File

PATCH /api/projects/{project_id}/files/{file_id}/trash HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
Sample Response
{
    "trashed":"success"
}

Notes

Note Object

{
    "id": 518,
    "name": "Creating a Template from an Existing Project",
    "content": "<p>Create a template by copying the customizations of an existing project. <br/>You will be given option to either include or exclude the assigned tasks<br/> to the new template. The new template will have all the discussions, <br/>tasks, files, notes, milestones and team members of the existing <br/>project. The completed tasks will be reopened automatically in the new <br/>template.<br/></p>",
    "modified_by": null,
    "resource_url": "/projects/1190/notes/518",
    "is_trashed": false,
    "created_on": "2016-07-21T10:53:26.663830Z",
    "modified_on": "2016-07-21T10:53:26.663857Z",
    "comment_count": 0,
    "created_by": {
        "id": 1,
        "first_name": "sathish",
        "last_name": "",
        "label_txt": "s",
        "is_crm_enabled": true,
        "is_crm_admin": true,
        "is_pm_enabled": true,
        "is_hrm_admin": true,
        "corp_email": true,
        "organization": {
            "id": 1,
            "name": "Dsqqqqqqq ds 2123",
            "domain": "adhome",
            "logo": "https://twprofile.s3.amazonaws.com/logos/image.jpeg",
            "email": "geo.jacob@adhome.com",
            "tenant_domain": "adhome.com",
            "created_on": "2015-03-10",
            "default_currency": "USD",
            "default_currency_symbol": "$",
            "label_txt": null,
            "orgkey": "Dsq",
            "status": "paying",
            "trial_end_on": "2016-07-07"
        },
        "image": "https://twprofile.s3.amazonaws.com/users/image.jpg",
        "email": "sathish@adhome.com",
        "full_name": "sathish ",
        "is_owner": true,
        "is_admin": true,
        "is_active": true,
        "last_login": "2016-07-21T06:24:04.037715Z",
        "job_title": "Developer",
        "time_zone": "Asia/Kolkata",
        "uuid": "7452387e2f1d4eda952cb12ffbefb6b1",
        "country": null,
        "is_noticeboard_enabled": true,
        "is_user_directory_enabled": true
    },
    "versions": [
        {
            "id": 972,
            "name": "Creating a Template from an Existing Project",
            "created_on": "2016-07-21T10:53:26.773477Z",
            "version": 1,
            "is_current": true,
            "created_by": {
                "id": 1,
                "first_name": "sathish",
                "last_name": "",
                "label_txt": "s",
                "is_crm_enabled": true,
                "is_crm_admin": true,
                "is_pm_enabled": true,
                "is_hrm_admin": true,
                "corp_email": true,
                "organization": {
                    "id": 1,
                    "name": "Dsqqqqqqq ds 2123",
                    "domain": "adhome",
                    "logo": "https://twprofile.s3.amazonaws.com/logos/image.jpeg",
                    "email": "geo.jacob@adhome.com",
                    "tenant_domain": "adhome.com",
                    "created_on": "2015-03-10",
                    "default_currency": "USD",
                    "default_currency_symbol": "$",
                    "label_txt": null,
                    "orgkey": "Dsq",
                    "status": "paying",
                    "trial_end_on": "2016-07-07"
                },
                "image": "https://twprofile.s3.amazonaws.com/users/image.jpg",
                "email": "sathish@adhome.com",
                "full_name": "sathish ",
                "is_owner": true,
                "is_admin": true,
                "is_active": true,
                "last_login": "2016-07-21T06:24:04.037715Z",
                "job_title": "Developer",
                "time_zone": "Asia/Kolkata",
                "uuid": "7452387e2f1d4eda952cb12ffbefb6b1",
                "country": null,
                "is_noticeboard_enabled": true,
                "is_user_directory_enabled": true
            },
            "resource_url": "/projects/1190/notes/518/version/972"
        }
    ],
    "is_private": false
}
Attribute Description
id (int) Identification number of the Note
name (string) title given of the Note
content (string) Description of the Note
modified_by (object) user object who modified the Note
resource_url (string) Note’s detail page access url
is_trashed (boolean) Status to check note is trashed or not
created_on (date) Note created date
modified_on (date) Date on which the note is modified
comment_count (int) No of comments for the note
created_by (object) User object who created the note
versions (array of objects) Version of the note
is_private (boolean) Status to check note is private or not

Version Object

Attribute Description
id (int) Identification number of the version
name (string) title given of the Note
created_on (date) Note created date
version (int) version number
is_current (boolean) Status to identify this is the current version of the note or not
created_by (object) User object who created the note version
resource_url (string) Note Version’s detail page access url

Create Note

POST api/projects/{project_id}/notes/{note_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
    "project":"1190",
    "name":"Creating a Template from an Existing Project",
    "content":
    "<p>Create a template
        by copying the customizations of an existing project. <br/>You will be given option to either include
        or exclude the assigned tasks<br/> to the new template. The new template will have all the discussions
        , <br/>tasks, files, notes, milestones and team members of the existing <br/>project. The completed tasks
        will be reopened automatically in the new <br/>template.<br/>
    </p>"
}

Update Note

PATCH api/projects/{project_id}/notes/{note_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
"id":520,
"name":"Creating a Template from an Existing Project",
"content":
    "<p><b>Create a template by
        copying the customizations</b> of an existing project. <br/>You will be given option to either include
        or exclude the assigned tasks<br/> to the new template. The new template will have all the discussions
        , <br/>tasks, files, notes, milestones and team members of the existing <br/>project. The completed tasks
        will be reopened automatically in the new <br/>template.<br/>
    </p>",
"modified_by":null,
"resource_url":"/projects/1190/notes/520",
"is_trashed":false,
"created_on":"2016-07-21T11:08:40.692271Z",
"modified_on":"2016-07-21T11:08:40.692310Z",
"comment_count":0,
"created_by": {
    "id": 1,
    "first_name": "sathish",
    "last_name": "",
    "label_txt": "s",
    "is_crm_enabled": true,
    "is_crm_admin": true,
    "is_pm_enabled": true,
    "is_hrm_admin": true,
    "corp_email": true,
    "organization": {
        "id": 1,
        "name": "Dsqqqqqqq ds 2123",
        "domain": "adhome",
        "logo": "https://twprofile.s3.amazonaws.com/image.jpeg",
        "email": "geo.jacob@adhome.com",
        "tenant_domain": "adhome.com",
        "created_on": "2015-03-10",
        "default_currency": "USD",
        "default_currency_symbol": "$",
        "label_txt": null,
        "orgkey": "Dsq",
        "status": "paying",
        "trial_end_on": "2016-07-07"
    },
    "image": "https://twprofile.s3.amazonaws.com/image.jpg",
    "email": "sathish@adhome.com",
    "full_name": "sathish ",
    "is_owner": true,
    "is_admin": true,
    "is_active": true,
    "last_login": "2016-07-21T06:24:04.037715Z",
    "job_title": "Developer",
    "time_zone": "Asia/Kolkata",
    "uuid": "7452387e2f1d4eda952cb12ffbefb6b1",
    "country": null,
    "is_noticeboard_enabled": true,
    "is_user_directory_enabled": true
},
"versions":[
    {
        "id": 972,
        "name": "Creating a Template from an Existing Project",
        "created_on": "2016-07-21T10:53:26.773477Z",
        "version": 1,
        "is_current": true,
        "created_by": {
            "id": 1,
            "first_name": "sathish",
            "last_name": "",
            "label_txt": "s",
            "is_crm_enabled": true,
            "is_crm_admin": true,
            "is_pm_enabled": true,
            "is_hrm_admin": true,
            "corp_email": true,
            "organization": {
                "id": 1,
                "name": "Dsqqqqqqq ds 2123",
                "domain": "adhome",
                "logo": "https://twprofile.s3.amazonaws.com/image.jpeg",
                "email": "geo.jacob@adhome.com",
                "tenant_domain": "adhome.com",
                "created_on": "2015-03-10",
                "default_currency": "USD",
                "default_currency_symbol": "$",
                "label_txt": null,
                "orgkey": "Dsq",
                "status": "paying",
                "trial_end_on": "2016-07-07"
            },
            "image": "https://twprofile.s3.amazonaws.com/image.jpg",
            "email": "sathish@adhome.com",
            "full_name": "sathish ",
            "is_owner": true,
            "is_admin": true,
            "is_active": true,
            "last_login": "2016-07-21T06:24:04.037715Z",
            "job_title": "Developer",
            "time_zone": "Asia/Kolkata",
            "uuid": "7452387e2f1d4eda952cb12ffbefb6b1",
            "country": null,
            "is_noticeboard_enabled": true,
            "is_user_directory_enabled": true
        },
        "resource_url": "/projects/1190/notes/518/version/972"
    }
],
"is_private":true,
}

Returns

If the call succeeds, it will return the Note object.

Delete Note

PATCH api/projects/{project_id}/notes/{note_id}/trash HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
    "trashed":"success"
}

Milestone

Milestone Object

{
    "id": 682,
    "title": "Customer issue completely fixed",
    "completed": false,
    "completed_on": null,
    "task_groups": [],
    "created_by": {
        "id": 1,
        "first_name": "sathish",
        "last_name": "",
        "label_txt": "s",
        "is_crm_enabled": true,
        "is_crm_admin": true,
        "is_pm_enabled": true,
        "is_hrm_admin": true,
        "corp_email": true,
        "organization": {
            "id": 1,
            "name": "Dsqqqqqqq ds 2123",
            "domain": "adhome",
            "logo": "https://twprofile.s3.amazonaws.com/image.jpeg",
            "email": "geo.jacob@adhome.com",
            "tenant_domain": "adhome.com",
            "created_on": "2015-03-10",
            "default_currency": "USD",
            "default_currency_symbol": "$",
            "label_txt": null,
            "orgkey": "Dsq",
            "status": "paying",
            "trial_end_on": "2016-07-07"
        },
        "image": "https://twprofile.s3.amazonaws.com/image.jpg",
        "email": "sathish@adhome.com",
        "full_name": "sathish ",
        "is_owner": true,
        "is_admin": true,
        "is_active": true,
        "last_login": "2016-07-21T06:24:04.037715Z",
        "job_title": "Developer",
        "time_zone": "Asia/Kolkata",
        "uuid": "7452387e2f1d4eda952cb12ffbefb6b1",
        "country": null,
        "is_noticeboard_enabled": true,
        "is_user_directory_enabled": true
    },
    "post_count": 0,
    "resource_url": "/projects/1190/milestones/682",
    "modified_on": "2016-07-21T11:42:02.351870Z",
    "modified_by": null,
    "start": "2016-07-22",
    "created_on": "2016-07-21T11:42:02.199063Z",
    "assigned_to": {
        "id": 1,
        "first_name": "sathish",
        "last_name": "",
        "label_txt": "s",
        "is_crm_enabled": true,
        "is_crm_admin": true,
        "is_pm_enabled": true,
        "is_hrm_admin": true,
        "corp_email": true,
        "organization": {
            "id": 1,
            "name": "Dsqqqqqqq ds 2123",
            "domain": "adhome",
            "logo": "https://twprofile.s3.amazonaws.com/image.jpeg",
            "email": "geo.jacob@adhome.com",
            "tenant_domain": "adhome.com",
            "created_on": "2015-03-10",
            "default_currency": "USD",
            "default_currency_symbol": "$",
            "label_txt": null,
            "orgkey": "Dsq",
            "status": "paying",
            "trial_end_on": "2016-07-07"
        },
        "image": "https://twprofile.s3.amazonaws.com/image.jpg",
        "email": "sathish@adhome.com",
        "full_name": "sathish ",
        "is_owner": true,
        "is_admin": true,
        "is_active": true,
        "last_login": "2016-07-21T06:24:04.037715Z",
        "job_title": "Developer",
        "time_zone": "Asia/Kolkata",
        "uuid": "7452387e2f1d4eda952cb12ffbefb6b1",
        "country": null,
        "is_noticeboard_enabled": true,
        "is_user_directory_enabled": true
    },
    "notify_when": "0",
    "notify_time": "06:00:00",
    "description": "fix all the issues",
    "is_trashed": false,
    "project": 1190,
    "is_private": false,
    "tmp_start": null,
    "project_name": "Pro_11"
}
Attribute Description
id (integer) Identification number of the milestone,
title (string) title given of the milestone,
completed (boolean) Status to check milestone is completed or not,
completed_on (date) completed date given of the milestone,
task_groups (array) task groups which belongs to the milestone,
created_by (object) User object who created the milestone,
post_count (integer) post count of the milestone,
resource_url (string) Milestone’s detail access url,
modified_on (date) Date on which the milestone is modified,
modified_by (object) user object who modified the milestone,
start (date) Start date of the milestone,
created_on (date) Date on which the milestone is created,
assigned_to (object) User object who is assigned to the milestone to complete,
notify_when (string) get a notification of the milestone on notify time,
notify_time (time) notification time of the milestone,
description (string) Description of the milestone,
is_trashed (boolean) Status to check milestone is trashed or not,
project (integer) Identification number of the project,
is_private (boolean) Status to check milestone is private or not,
tmp_start (date) Temporary start date of the milestone,
project_name (string) name of the project,

Create Milestone

POST api/projects/{project_id}/milestones HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
    "id":0,
    "title":"Customer issue completely fixed",
    "is_milestone":true,
    "notify_when":0,
    "notify_time":"06:00:00",
    "start":"2016-08-10",
    "assigned_to":
        {
            "id":1
        },
    "description":"fix all the issues",
    "object_id":"1190",
    "is_private":false
}

Update Milestone

PATCH api/projects/{project_id}/milestones/{milestone_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
    "id":683,
    "title":"Customer issue completely fixed",
    "completed":false,
    "completed_on":null,
    "task_groups":[],
    "created_by": {
        "id": 1,
        "first_name": "sathish",
        "last_name": "",
        "label_txt": "s",
        "is_crm_enabled": true,
        "is_crm_admin": true,
        "is_pm_enabled": true,
        "is_hrm_admin": true,
        "corp_email": true,
        "organization": {
            "id": 1,
            "name": "Dsqqqqqqq ds 2123",
            "domain": "adhome",
            "logo": "https://twprofile.s3.amazonaws.com/image.jpeg",
            "email": "geo.jacob@adhome.com",
            "tenant_domain": "adhome.com",
            "created_on": "2015-03-10",
            "default_currency": "USD",
            "default_currency_symbol": "$",
            "label_txt": null,
            "orgkey": "Dsq",
            "status": "paying",
            "trial_end_on": "2016-07-07"
        },
        "image": "https://twprofile.s3.amazonaws.com/image.jpg",
        "email": "sathish@adhome.com",
        "full_name": "sathish ",
        "is_owner": true,
        "is_admin": true,
        "is_active": true,
        "last_login": "2016-07-21T06:24:04.037715Z",
        "job_title": "Developer",
        "time_zone": "Asia/Kolkata",
        "uuid": "7452387e2f1d4eda952cb12ffbefb6b1",
        "country": null,
        "is_noticeboard_enabled": true,
        "is_user_directory_enabled": true
    },
    "post_count":0,
    "resource_url":"/projects/1190/milestones/683",
    "modified_on":"2016-07-21T11:59:54.589285Z",
    "modified_by":null,
    "start":"2016-08-11",
    "created_on":"2016-07-21T11:59:54.589259Z",
    "assigned_to": {
        "id": 1,
        "first_name": "sathish",
        "last_name": "",
        "label_txt": "s",
        "is_crm_enabled": true,
        "is_crm_admin": true,
        "is_pm_enabled": true,
        "is_hrm_admin": true,
        "corp_email": true,
        "organization": {
            "id": 1,
            "name": "Dsqqqqqqq ds 2123",
            "domain": "adhome",
            "logo": "https://twprofile.s3.amazonaws.com/image.jpeg",
            "email": "geo.jacob@adhome.com",
            "tenant_domain": "adhome.com",
            "created_on": "2015-03-10",
            "default_currency": "USD",
            "default_currency_symbol": "$",
            "label_txt": null,
            "orgkey": "Dsq",
            "status": "paying",
            "trial_end_on": "2016-07-07"
        },
        "image": "https://twprofile.s3.amazonaws.com/image.jpg",
        "email": "sathish@adhome.com",
        "full_name": "sathish ",
        "is_owner": true,
        "is_admin": true,
        "is_active": true,
        "last_login": "2016-07-21T06:24:04.037715Z",
        "job_title": "Developer",
        "time_zone": "Asia/Kolkata",
        "uuid": "7452387e2f1d4eda952cb12ffbefb6b1",
        "country": null,
        "is_noticeboard_enabled": true,
        "is_user_directory_enabled": true
    },          
    "notify_when":"0",
    "notify_time":"06:00:00",
    "description":"fix all the issues",
    "is_trashed":false,
    "project":1190,
    "is_private":true,
    "tmp_start":null,
    "project_name":"Pro_11",
    "action_type":"added",
    "is_milestone":true,
    "_id":"683",
    "_start":"2016-08-09T18:30:00.000Z",
    "end":null,
    "_end":null,
    "allDay":true,
    "className":[]
}

Complete the Milestone

PATCH api/projects/{project_id}/milestones/{milestone_id}/complete HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
Sample Response
{
    "completed":"success"
}

Delete Milestone

PATCH api/projects/{project_id}/milestones/{milestone_id}/trash HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
Sample Response
{
    "trashed":"success"
}

Time log

Time log Object

{
    "id": 548,
    "description": "Issues fixed and updated.",
    "project": 1190,
    "task": 5403,
    "logdate": "2016-07-22",
    "logtime": "4:30",
    "is_billable": true,
    "task_object": {  
            "taskgroup_id":919,
            "id":3208,
            "name":"social"
         },
    "log_month": "July, 2016",
    "created_on": "2016-07-22T06:27:53.602712Z",
    "created_by": {
        "id": 11,
        "first_name": "aravind",
        "last_name": "dsSpring",
        "label_txt": "ad",
        "is_crm_enabled": false,
        "is_crm_admin": false,
        "is_pm_enabled": true,
        "is_hrm_admin": false,
        "corp_email": true,
        "organization": {
            "id": 1,
            "name": "Dsqqqqqqq ds 2123",
            "domain": "adhome",
            "logo": "https://twprofile.s3.amazonaws.com/logo.jpeg",
            "email": "geo.jacob@adhome.com",
            "tenant_domain": "adhome.com",
            "created_on": "2015-03-10",
            "default_currency": "USD",
            "default_currency_symbol": "$",
            "label_txt": null,
            "orgkey": "Dsq",
            "status": "paying",
            "trial_end_on": "2016-07-07"
        },
        "image": null,
        "email": "aravind@adhome.com",
        "full_name": "aravind dsSpring",
        "is_owner": false,
        "is_admin": false,
        "is_active": true,
        "last_login": "2016-07-22T06:26:52.720693Z",
        "job_title": "Developer",
        "time_zone": "Asia/Kolkata",
        "uuid": "340aec4d05984fa880a915c6c72ea794",
        "country": null,
        "is_noticeboard_enabled": false,
        "is_user_directory_enabled": true
    },
    "resource_url": "/projects/1190/timelogs/548",
    "modified_on": "2016-07-22T06:27:53.602749Z",
    "billed": false,
    "modified_by": null
}
Attribute Description
id (integer) Identification number of the time log
description (string) Description for the time log
project (integer) Identification number of the Project
task (integer) Identification number of the task for the time log
logdate (date) log date of the time log
logtime (time) Total time spend for the task
is_billable (boolean) Status to check time log is billable or not
task_object (object) Particular task object for the time log
log_month (string) Month and Year on which the time log is created
created_on (date) Time log created date
created_by (object) User object who created the timelog
resource_url (string) Timelog’s detail page access url
modified_on (date) Date on which the time log is modified
billed (boolean) Status to check time log is billed or not
modified_by (object) user object who modified the time log

Timelog Task Object

Attibute Description
taskgroup_id (integer) ID of the taskgroup_id
id (integer) ID of the task
name (string) Name of the task

Retrieve Time log

Sample Request 
GET  api/projects/825/timelogs?dateRange=This Week&dateRangeEnd=20/05/2016&dateRangeStart=25/05/2016  HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

URL Parameters for filtering time logs:

Based on dates: dateRange , dateRangeEnd, dateRangeStart
Value Description
This Week by week
Today for today
Yesterday for yesterday
Last Week for last week
Last Month for last month
This Month for this month
This Quarter for this quarter
Last Quarter for last quarter
From Beginning from the beginning
Based on User: user

Create Time log

POST /api/projects/{project_id}/timelogs HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
    "description":"Issues fixed and updated.",
    "logdate":"2016-07-22",
    "logtime":"4:18",
    "task":5403,
    "is_billable":true
    }

Update Time log

PATCH /api/projects/{project_id}/timelogs/{timelog_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
    "description":"New dependencies are added for monitoring and updated on online.",
    "logdate":"2016-07-22",
    "logtime":"5:30",
    "task":5403,
    "is_billable":true
}

Delete Time log

DELETE api/projects/{project_id}/timelogs/{timelog_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

Events

Event Object

{
    "id": 3633,
    "title": "Slide Presentation",
    "description": "Give a detail about upcoming projects",
    "start_dt": "2016-07-22T16:30:00Z",
    "end_dt": "2016-07-22T17:30:00Z",
    "start": "2016-07-22 16:30:00+00:00",
    "end": "2016-07-22 17:30:00+00:00",
    "all_day": false,
    "start_time": "04:30 PM",
    "end_time": "05:30 PM",
    "rule_txt": false,
    "rule_id": null,
    "end_type": "never",
    "occurrence_count": "2",
    "end_recurring_period": null,
    "is_private": false,
    "post_count": 0
}
Attribute Description
id (integer) Identificatoin number of the Event,
title (string) Title of the Event,
description (string) Description given of the Event,
start_dt (date) Start date of the Event,
end_dt (date) End date the Event,
start (datetime) Start date time of the Event,
end (datetime) End date time of the Event,
all_day (boolean) Status to check the event will occur all day or not,
start_timet (datetime) Start time of the Event,
end_timet (datetime) End time of the Event,
rule_txt (string) Event repeat information,
rule_id (string) Id of the repeat mode,
end_type (string) end_type can be ‘never’,'occurrence’ or 'date’,
occurrence_count (integer) Occurrence count of the event,
end_recurring_period (string) It can be null if end_type is 'never’ or a paricular date if end_type is 'date,
is_private (boolean) Status to check note is private or not,
post_count (integer) Post count of the event

Create Event

POST api/projects/{project_id}/events HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
    "id":0,
    "title":"Slide Presentation",
    "occurrence_count":0,
    "rule_id":0,
    "end_type":"never",
    "start":"2016-07-22",
    "start_time":"10:00 PM",
    "end_time":"11:00PM",
    "end":"2016-07-22",
    "all_day":false,
    "end_recurring_period":"",
    "repeat":false,
    "send_email":true,
    "description":"Give a detail about upcoming projects",
    "emails":[1],
    "is_repeating":false
 }

Update Event

PATCH api/projects/{project_id}/events/{event_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
    "id":13633,
    "event":3633,
    "all_day":true,
    "order_no":1,
    "title":"Slide Presentation Every day",
    "created_by": {
        "id": 1,
        "first_name": "sathish",
        "last_name": "",
        "label_txt": "s",
        "is_crm_enabled": true,
        "is_crm_admin": true,
        "is_pm_enabled": true,
        "is_hrm_admin": true,
        "corp_email": true,
        "organization": {
            "id": 1,
            "name": "Dsqqqqqqq ds 2123",
            "domain": "adhome",
            "logo": "https://twprofile.s3.amazonaws.com/image.jpeg",
            "email": "geo.jacob@adhome.com",
            "tenant_domain": "adhome.com",
            "created_on": "2015-03-10",
            "default_currency": "USD",
            "default_currency_symbol": "$",
            "label_txt": null,
            "orgkey": "Dsq",
            "status": "paying",
            "trial_end_on": "2016-07-07"
        },
        "image": "https://twprofile.s3.amazonaws.com/image.jpg",
        "email": "sathish@adhome.com",
        "full_name": "sathish ",
        "is_owner": true,
        "is_admin": true,
        "is_active": true,
        "last_login": "2016-07-21T06:24:04.037715Z",
        "job_title": "Developer",
        "time_zone": "Asia/Kolkata",
        "uuid": "7452387e2f1d4eda952cb12ffbefb6b1",
        "country": null,
        "is_noticeboard_enabled": true,
        "is_user_directory_enabled": true
    },
    "emails":[1],
    "is_repeating":false,
    "is_private":false,
    "start":"2016-07-22",
    "start_time":"10:00PM",
    "old_start":"2016-07-22",
    "old_start_time":"10:00 PM",
    "end":"2016-07-22",
    "end_time":"11:00 PM",
    "old_end":"2016-07-22",
    "old_end_time":"11:00 PM",
    "description":"Give a detail about upcoming projects",
    "rule_txt":false,
    "rule_id":0,
    "end_type":"never",
    "occurrence_count":0,
    "end_recurring_period":"",
    "durationEditable":false,
    "is_milestone":false,
    "post_count":0,
    "send_email":true,
    "_id":"13633",
    "_start":"2016-07-21T18:30:00.000Z",
    "_end":null,
    "allDay":true,
    "className":[],
    "repeat":false,
    "event_id":3633,
    "old_event_data":{
        "event_id":3633,
        "title":"SlidePresentation",
        "start":"2016-07-22",
        "end":"2016-07-22",
        "start_time":"10:00 PM",
        "end_time":"11:00 PM"
        }
}

Delete Event

PATCH api/projects/{project_id}/events/{event_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

CRM

CRM provides various Customer related operations using the /crm resource and related sub-resources. Use HRM for managing new employees, timeoff, and automatic check-ins. You can also use sub-resources to get employees, timeoff, tasks and automatic check-ins related details.

Deal

Deal Object

{
 "id":3374,
 "created_by":{
    "url":"/users/1",
    "image":"https://twprofile.s3.amazonaws.com/image.jpg",
    "id":1,
    "full_name":"Sathish Venkat",
    "email":"sathish@adhome.com",
    "label_txt":"SV"
 },
 "owner":{
    "url":"/users/1",
    "image":"https://twprofile.s3.amazonaws.com/image.jpg",
    "id":1,
    "full_name":"Sathish Venkat",
    "email":"sathish@adhome.com",
    "label_txt":"SV"
 },
 "title":"d3",
 "index":0,
 "stage":{
    "index":0,
    "total_stage":5,
    "title":"Prospect Lead",
    "rotting_days":null,
    "is_deal_rotting":false,
    "id":529
 },
 "deal_value":"0.00",
 "currency":{
    "is_custom":false,
    "symbol":"$",
    "code":"USD",
    "id":191
 },
 "expected_close":null,
 "last_activity_on":"2016-07-13",
 "next_activity_on":null,
 "is_trashed":false,
 "status":"open",
 "people":[
    {
       "id":17591,
       "email":"sathishv@dsss.com",
       "first_name":"sathish",
       "last_name":"v",
       "phone":"212121",
       "job_title":"wqwqwqw",
       "full_name":"sathish v",
       "profile_image":null,
       "company":10150,
       "company_name":"DSSS",
       "tags":null
    },
    {
       "id":5664,
       "email":"",
       "first_name":"sathisgg",
       "last_name":"",
       "phone":"",
       "job_title":"",
       "full_name":"sathisgg",
       "profile_image":null,
       "company":null,
       "company_name":null,
       "tags":null
    }
 ],
 "company":{
    "domain":"",
    "name":"satsss",
    "image":null,
    "ctype":"company",
    "phone":"",
    "address":"",
    "id":10206
 },
 "created_on":"2016-07-13T10:04:51.246672Z",
 "tags": "Cloud",
 "custom_fields":{
    "77":{
       "field_type":"checkbox",
       "name":"Priority",
       "value":{
          "High":false
       },
       "key":"Low Priority",
       "options":[
          "Low"
       ],
       "is_add_field":true
    }
 },
 "won_on":null,
 "lost_on":null,
 "closed_on":null
}
Attribute Description
id (integer) ID of the deal
created_by (object) info about the creator of the deal
owner (object) info about the owner of the deal, can be changed(by default, owner is creator)
title (string) title of the deal
index (integer) order of the deal to show
stage (object) stage details
deal_value (integer) Value set for the deal
currency (object) Currency set for the deal
expected_close (string) expected closing date for the deal
last_activity_on (string) date of the last activity done on the deal
next_activity_on (string) date of the next activity on the deal
is_trashed (boolean) is the deal removed
people (object) contacts involved in the deal
company (object) company info
created_on (string) date of creation of the deal
tags (string) tags added to the deal
custom_fields (object) objects of custom fields
won_on (string) date of winning the deal
lost_on (string) date of losing the deal
closed_on (string) date of closing the deal

Stage Object

Attribute Description
index (integer) order of the stage
title (string) stage name
total_stage (integer) total number of stages
rotting_days (integer) number of set days for rotting
is_deal_rotting (boolean) is the deal rotten or not
id (integer) ID of the deal in the stage

Currency Object

Attribute Description
is_custom (boolean) if currency is customized
symbol (string) symbol used to represent the currency
code (string) code for the currency
id (integer) currency ID

People Object

Attribute Description
id (integer) ID of the contact
email (string) email address
first_name (string) first name of the contact
last_name (string) last name of the contact
phone (string) phone number of the contact
job_title (string) Desgination of the contact
full_name (string) full name of the contact
profile_image (string) image url for the contact
company (string) company ID of the contact
company_name (string) Company name of the contact
tags (string) tags for the contact

Custom Fields Object

Attribute Description
field_type (string) type of field added
name (string) label of the field
value (string) default value for the field
key (string) key value for the field
options (string) options for the checkbox
is_add_field (boolean) if the field should appear in the add deal form

Create Deal Object

POST api/crm/deals HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
Sample Request
{
   "stage":{
      "id":529,
      "title":"Prospect Lead",
      "is_trashed":false,
      "index":0,
      "is_deal_rotting":false,
      "rotting_days":null,
      "no_of_deals":136
   },
   "custom_fields":{
      "73":{
         "field_type":"text",
         "name":"sdsd",
         "key":"sdsd",
         "options":null
      },
      "74":{
         "field_type":"select",
         "name":"ed",
         "key":"ed",
         "options":[
            "ewded"
         ]
      },
      "75":{
         "field_type":"textarea",
         "name":"wedwed",
         "key":"wedwed",
         "options":null
      },
      "76":{
         "field_type":"radio",
         "name":"sdwd",
         "key":"sdwd",
         "options":[
            "dwdw"
         ],
         "value":"dwdw"
      },
      "77":{
         "field_type":"checkbox",
         "name":"wedwd",
         "key":"wedwd",
         "options":{
            "wedwd":false
         },
         "value":{
            "wedwd":false
         }
      },
      "78":{
         "field_type":"date",
         "name":"wedwdwqdw",
         "key":"wedwdwqdw",
         "options":null,
         "value":"2016-07-02"
      }
   },
   "currency":194,
   "pipeline":39,
   "title":"Test Deal",
   "deal_value":"25000",
   "expected_close":"2016-07-29"
}
Sample Response
{
   "id":3379,
   "owner":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.com/users/user-8011f79c-007c-4943-a968-1d13dd13b1d9-image
.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "title":"test deal",
   "index":0,
   "stage":{
      "index":0,
      "total_stage":5,
      "title":"Prospect Lead",
      "rotting_days":null,
      "is_deal_rotting":false,
      "id":529
   },
   "deal_value":"25000.00",
   "currency":{
      "is_custom":false,
      "symbol":"₹",
      "code":"INR",
      "id":194
   },
   "company":null,
   "expected_close":"2016-07-20",
   "last_activity_on":"2016-07-14",
   "next_activity_on":null,
   "status":"open",
   "is_trashed":false,
   "people":[

   ],
   "pipeline":39,
   "tags":null,
   "custom_fields":{
      "77":{
         "field_type":"checkbox",
         "name":"wedwd",
         "value":{
            "wedwd":false
         },
         "key":"wedwd",
         "options":[
            "wedwd"
         ],
         "is_add_field":true
      },
      "74":{
         "field_type":"select",
         "name":"ed",
         "value":"ewded",
         "key":"ed",
         "options":[
            "ewded"
         ],
         "is_add_field":true
      }
   },
   "won_on":null,
   "lost_on":null
}

Returns

If the call succeeds, it will return the deal object.

Update Deal

POST api/crm/deals HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
Sample Request
{
   "id":3379,
   "created_by":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.com/users/user-8011f79c-007c-4943-a968-1d13dd13b1d9-image
.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "owner":{
      "id":1,
      "image":"https://twprofile.s3.amazonaws.com/users/user-8011f79c-007c-4943-a968-1d13dd13b1d9-image
.jpg",
      "full_name":"Sathish Venkat",
      "label_txt":"SV"
   },
   "title":"test deal",
   "index":0,
   "stage":{
      "id":529,
      "title":"Prospect Lead",
      "is_trashed":false,
      "index":0,
      "is_deal_rotting":false,
      "rotting_days":null,
      "no_of_deals":140
   },
   "deal_value":"225000.00",
   "currency":194,
   "expected_close":"2016-07-20",
   "last_activity_on":"2016-07-14",
   "next_activity_on":null,
   "is_trashed":false,
   "status":"open",
   "people":[

   ],
   "company":null,
   "created_on":"2016-07-14T10
:14:53.831473Z",
   "tags":null,
   "custom_fields":{
      "73":{
         "field_type":"text",
         "name":"sdsd",
         "key":"sdsd",
         "options":null
      },
      "74":{
         "field_type":"select",
         "name":"ed",
         "value":"ewded",
         "key":"ed",
         "options":[
            "ewded"
         ],
         "is_add_field":true
      },
      "75":{
         "field_type":"textarea",
         "name":"wedwed",
         "key":"wedwed",
         "options":null
      },
      "76":{
         "field_type":"radio",
         "name":"sdwd",
         "key":"sdwd",
         "options":[
            "dwdw"
         ]
      },
      "77":{
         "field_type":"checkbox",
         "name":"wedwd",
         "value":{
            "wedwd":false
         },
         "key":"wedwd",
         "options":[
            "wedwd"
         ],
         "is_add_field":true
      },
      "78":{
         "field_type":"date",
         "name":"wedwdwqdw",
         "key":"wedwdwqdw",
         "options":null
      }
   },
   "won_on":null,
   "lost_on":null,
   "closed_on":null,
   "pipeline":39
}
Sample Response
{
   "id":3379,
   "created_by":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.comimage.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "owner":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.com/image.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "title":"test deal",
   "index":0,
   "stage":{
      "index":0,
      "total_stage":5,
      "title":"Prospect Lead",
      "rotting_days":null,
      "is_deal_rotting":false,
      "id":529
   },
   "deal_value":"225000.00",
   "currency":{
      "is_custom":false,
      "symbol":"
₹",
      "code":"INR",
      "id":194
   },
   "expected_close":"2016-07-20",
   "last_activity_on":"2016-07-14",
   "next_activity_on":null,
   "is_trashed":false,
   "status":"open",
   "people":[

   ],
   "company":null,
   "created_on":"2016-07-14T10:14:53
.831473Z",
   "tags":null,
   "custom_fields":{
      "77":{
         "field_type":"checkbox",
         "name":"wedwd",
         "value":{
            "wedwd":false
         },
         "key":"wedwd",
         "options":[
            "wedwd"
         ],
         "is_add_field":true
      },
      "74":{
         "field_type":"select",
         "name":"ed",
         "value":"ewded",
         "key":"ed",
         "options":[
            "ewded"
         ],
         "is_add_field":true
      }
   },
   "won_on":null,
   "lost_on":null,
   "closed_on":null
}

Returns

If the call succeeds, it will return the deal object.

Delete Deal

PATCH api/crm/deals/{deal_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
Sample Request
  {
    "is_trashed":true
  }
Sample Response
{
   "id":3380,
   "created_by":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.com/image.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "owner":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.com/image.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "title":"DA10",
   "index":0,
   "stage":{
      "index":0,
      "total_stage":5,
      "title":"Prospect Lead",
      "rotting_days":null,
      "is_deal_rotting":false,
      "id":529
   },
   "deal_value":"0.00",
   "currency":{
      "is_custom":false,
      "symbol":"$",
      "code":"USD",
      "id":191
   },
   "expected_close":null,
   "last_activity_on":"2016-07-15",
   "next_activity_on":null,
   "is_trashed":true,
   "status":"open",
   "people":[
   ],
   "company":null,
   "created_on":"2016-07-14T11:33:39.610202Z",
   "tags":null,
   "custom_fields":{
      "77":{
         "field_type":"checkbox",
         "name":"wedwd",
         "value":{
            "wedwd":false
         },
         "key":"wedwd",
         "options":[
            "wedwd"
         ],
         "is_add_field":true
      }
   },
   "won_on":null,
   "lost_on":null,
   "closed_on":null
}

Returns

If the patch call succeeds, it will return the deal object

Make a Deal Won/Lost

PATCH api/crm/deals/{deal_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
Sample Request 
  {
    "status":"won"
  }
Sample Response
{
   "id":3379,
   "created_by":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.com/image.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "owner":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.com/image.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "title":"test deal",
   "index":1,
   "stage":{
      "index":0,
      "total_stage":5,
      "title":"Prospect Lead",
      "rotting_days":null,
      "is_deal_rotting":false,
      "id":529
   },
   "deal_value":"225000.00",
   "currency":{
      "is_custom":false,
      "symbol":"
₹",
      "code":"INR",
      "id":194
   },
   "expected_close":"2016-07-20",
   "last_activity_on":"2016-07-15",
   "next_activity_on":null,
   "is_trashed":false,
   "status":"won",
   "people":[

   ],
   "company":null,
   "created_on":"2016-07-14T10:14:53
.831473Z",
   "tags":null,
   "custom_fields":{
      "77":{
         "field_type":"checkbox",
         "name":"wedwd",
         "value":{
            "wedwd":false
         },
         "key":"wedwd",
         "options":[
            "wedwd"
         ],
         "is_add_field":true
      },
      "74":{
         "field_type":"select",
         "name":"ed",
         "value":"ewded",
         "key":"ed",
         "options":[
            "ewded"
         ],
         "is_add_field":true
      }
   },
   "won_on":"2016-07-15T06:35:22.694755Z",
   "lost_on":null,
   "closed_on":"2016-07-15"
}
Attribute Value Description
status ‘won’ deal is won
status 'lost’ deal is lost

Returns

If the call succeeds, it will return the deal object with updated data

Add Note in Deals

POST api/crm/deals/{deal_id}/notes HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
Sample Request 
{
"content": "<p>Test Note<br/></p>"
}
Sample Response
{
   "id":202,
   "content":"<p>Test Note<br/></p>",
   "created_by":{
      "url":"/users/1",
      "image":"https://s3.amazonaws.com/image.jpg",
      "id":1,
      "full_name":"Jamie Jackson",
      "email":"jamie@adhome.com",
      "label_txt":"SV"
   },
   "act_on":"2016-08-11T05:47:22.470967Z",
   "is_pinned":false
}

Mails

Mail Object

{
  "id":8,
  "deal":{
      "title":"Test IPL",
      "ctype":"deal",
      "deal_value":0.0,
      "currency_symbol":"$",
      "owner":{
         "url":"/users/221",
         "image":"",
         "id":221,
         "full_name":"Prasad Vara",
         "email":"prasad@adhome.com",
         "label_txt":"PV"
      },
      "id":3244,
      "stage":{
         "index":0,
         "total_stage":5,
         "title":"Prospect Lead",
         "rotting_days":null,
         "is_deal_rotting":false,
         "id":529
      }
   },
  "people":[
     {
        "id":1,
        "email":"sachin@adhome.com",
        "first_name":"Sachin",
        "last_name":"N",
        "phone":"8884546564",
        "job_title":"Designer",
        "full_name":"Sachin N",
        "profile_image":null,
        "company":1,
        "company_name":"Gensis",
        "tags":null
     },
     {
        "id":1910,
        "email":"deal-265@sandbox4ace1c73643542298f3f7cbc08cdc826.mailgun.org",
        "first_name":"deal-265",
        "last_name":"",
        "phone":null,
        "job_title":null,
        "full_name":"deal-265",
        "profile_image":null,
        "company":null,
        "company_name":null,
        "tags":null
     }
  ],
  "from_str":"Sathish Kumar <sathish@adhome.com>",
  "subject":"test",
  "body_html":"<div dir=\"ltr\">test<br clear=\"all\"><div><br></div
    >-- <br><div class=\"gmail_signature\"><div><font color=\"#333333\">Regards,</font><div><font color=
    \"#333333\">Sathishkumar V</font></div></div><font color=\"#333333\"><a href=\"http://www.adhome
    .com/\" target=\"_blank\">Double Spring Media India  (P) Ltd</a></font><div><font color=\"#333333\">
    <br></font><div><font color=\"#333333\" face=\"arial, sans-serif\" size=\"3\"><br></font></div></div
    ></div>\r\n</div>\r\n",
  "created_by":{
     "url":"/users/1",
     "image":"https://twprofile.s3.amazonaws.com/image.jpg",
     "id":1,
     "full_name":"Sathish Venkat",
     "email":"sathish@adhome.com",
     "label_txt":"SV"
  },
  "received":"2015-10-30T13:50:31.081463Z",
  "is_archived":false,
  "is_private":true,
  "is_read":true,
  "act_on":"2015-10-30T13:50:31.081463Z"
}
Attribute Description
id (integer) ID of the mail
deal (object) object with data about deal or company.
people (object) array of contacts connected to the mail(To,CC)
from_str (string) Name and mail of the sender
subject (string) subject for the mail
body_html (string) body content in html format
created_by (object) user details of creator
received (string) date of receiving the mail
is_archived (boolean) is the mail archived
is_private (boolean) is the mail private
is_read (boolean) is the mail read
act_on (string) date for the mail activity

Deal Object

Attribute Description
title (string) title of the deal connected
ctype (string) it will change according to the content it is sending to the frontend.
deal_value (integer) value of the deal
currency_symbol (string) currency symbol
owner (object) owner data
id (integer) ID for the deal
stage (object) stage info

People Object

Attribute Description
id (integer) ID of the contact
email (string) email address
first_name (string) first name of the contact
last_name (string) last name
phone (string) phone number of the contact
job_title (string) desgination of the contact
full_name (string) full name of the contact
profile_image (string) image url of the contact
company (string) company ID
company (string) Company name
tags (string) tags related to the contact

Connect Deal To Mail

PATCH /api/crm/emails/{mail_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
Sample Request
 {
  "deal":3375
 }
Sample Response
{
   "id":2,
   "deal":{
      "title":"Test IPL",
      "ctype":"deal",
      "deal_value":0.0,
      "currency_symbol":"$",
      "owner":{
         "url":"/users/221",
         "image":"",
         "id":221,
         "full_name":"Prasad Vara",
         "email":"prasad@adhome.com",
         "label_txt":"PV"
      },
      "id":3244,
      "stage":{
         "index":0,
         "total_stage":5,
         "title":"Prospect Lead",
         "rotting_days":null,
         "is_deal_rotting":false,
         "id":529
      }
   },
   "people":[

   ],
   "from_str":"Sathish Kumar <sathish@adhome.com>",
   "subject":"test",
   "body_html":"<div dir=\"ltr\">test<br clear=\"all\"><div><br></div>-- <br><div class=\"gmail_signature
     \><div><font color=\"#333333\">Regards,</font><div><font color=\"#333333\">Sathishkumar V</font></div
         Media India  (P) Ltd</a></font><div><font color=\"#333333\"><br></font><div><font color=\"#333333\"
      face=\"arial, sans-serif\" size=\"3\"><br></font></div></div></div>\r\n</div>\r\n",
   "created_by":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.com/users/image.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "received":"2015-10-30T13:22:55.528585Z",
   "is_archived":false,
   "is_private":true,
   "is_read":true,
   "act_on":"2015-10-30T13:22:55.528585Z"
}

Returns

If the call succeeds, it will return the mail object with updated deal name.

Activities

Activity Object

 {
      "id":409,
      "act_type":{
         "icon":"icon-send",
         "id":463,
         "title":"Email"
      },
      "assigned_to":{
         "url":"/users/272",
         "image":"",
         "id":272,
         "full_name":"Rajdeep Sharma",
         "email":"rajdeep@adhome.com",
         "label_txt":"RS"
      },
      "person":{
         "phone":null,
         "name":"testContsct",
         "full_name":"testContsct",
         "image":null,
         "job_title":null,
         "id":15435,
         "ctype":"person",
         "email":null
      },
      "company":{
         "domain":null,
         "name":"adhome",
         "image":null,
         "ctype":"company",
         "phone":"96633",
         "address":"15/1",
         "id":8452
      },
      "deal":{
         "id":2757,
         "ctype":"deal",
         "dealname":"Segment Deal"
      },
      "activity_due_on":"2016-07-13T08:15:00",
      "due_time":"08:15 AM",
      "act_on":"2016-07-13T08:15:00",
      "add_next":false,
      "title":"Email",
      "note":"Please fill in your Folio No., Name, PAN & Bank Account
        details in Section 2 & 3, and then proceed to Section 5",
      "due_date":"2016-07-13",
      "duration":"00:30",
      "is_completed":false,
      "completed_on":null,
      "is_trashed":false
   }
Attribute Description
id (integer) Activity ID
act_type (object) activity type
assigned_to (object) list of people assigned to the activity
person (object) contact person details
company (object) organisation details
deal (object) deals info
activity_due_on (date string) due date-time for the activity
due_time (date string) due time of the activity
due_date (date string) due date of the activity
add_next (boolean) if the activity added next
title (string) title of the activity
note (string) description of the activity
duration (string) duration of the activity in hrs
is_completed (boolean) is the activity completed
completed_on (string) date of complete
is_trashed (boolean) is the activity deleted

Activity Type Object

Attribute Description
icon (string) icon name for the activity type
id (integer) ID of the activity type
title (string) title of the activity type

Person Object

Attribute Description
phone (string) phone number of the contact person
name (string) name of the contact person
full_name (string) full name of the contact person
image (url string) image url for the contact
job_title (string) Desgination
id (integer) ID of the contact person
ctype (string) content type (‘person’)
email (string) email address

Company Object

Attribute Description
domain (string) domain name for the company
name (string) name of the company
image (string) image url for the company logo
ctype (string) content type ('company’)
phone (string) phone number
address (string) Company address
id (integer) Company ID

Deals object

Attribute Description
id (integer) ID of the deal
ctype (string) content type ('deal’)
dealname (string) Deal name

Create Activity

POST api/crm/activities HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
Sample Request

{
   "due_date":"2016-07-18",
   "title":"Email",
   "act_type":{
      "id":463,
      "title":"Email",
      "icon":"icon-send",
      "is_trashed":false
   },
   "assigned_to":{
      "id":1,
      "full_name":"Sathish Venkat"
   },
   "person":1,
   "company":10141,
   "deal":3376,
   "note":"This is a test deadline activity",
   "due_time":"08:00 AM",
   "duration":"01:00"
}
Sample Response
{
   "id":424,
   "act_type":{
      "icon":"icon-send",
      "id":463,
      "title":"Email"
   },
   "assigned_to":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.com/users/user-8011f79c-007c-4943-a968-1d13dd13b1d9-image.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "person":{
      "phone":"8884546564",
      "name":"Sachin N",
      "full_name":"Sachin N",
      "image":null,
      "job_title":"Designer",
      "id":1,
      "ctype":"person",
      "email":"sachin@adhome.com"
   },
   "company":{
      "domain":"www.google.com",
      "name":"adhome
 Media India pvt Ltd",
      "image":null,
      "ctype":"company",
      "phone":"080-41250414",
      "address":"Frazer Town",
      "id":10141
   },
   "deal":{
      "id":3376,
      "ctype":"deal",
      "dealname":"Test Deal"
   },
   "activity_due_on":"2016-07-18T08:00
:00",
   "due_time":"08:00 AM",
   "act_on":"2016-07-18T08:00:00",
   "add_next":false,
   "title":"Email",
   "note":"This
 is a test deadline activity",
   "due_date":"2016-07-18",
   "duration":"01:00",
   "is_completed":false,
   "completed_on":null,
   "is_trashed":false
}

Returns

If the call succeeds, it will return the activity object with given data.

Update Activity

PUT api/crm/activities/{activity_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
Sample Request
{
   "id":389,
   "act_type":{
      "icon":"icon-send",
      "id":463,
      "title":"Email"
   },
   "assigned_to":{
      "id":221,
      "full_name":"Prasad Vara"
   },
   "person":17561,
   "company":10121,
   "deal":3207,
   "activity_due_on":"2016-05-27",
   "due_time":null,
   "act_on":"2016-05-27T00:00:00",
   "add_next":false,
   "title":"Email",
   "note":null,
   "due_date":"2016-05-28",
   "duration":null,
   "is_completed":false,
   "completed_on":null,
   "is_trashed":false
}
Sample Response
{
   "id":389,
   "act_type":{
      "icon":"icon-send",
      "id":463,
      "title":"Email"
   },
   "assigned_to":{
      "url":"/users/221",
      "image":"",
      "id":221,
      "full_name":"Prasad Vara",
      "email":"prasad@adhome.com",
      "label_txt":"PV"
   },
   "person":{
      "phone":"9663078168",
      "name":"Akenani Nagarujina",
      "full_name":"Akenani Nagarujina",
      "image":null,
      "job_title":null,
      "id":17561,
      "ctype":"person",
      "email":"contactprasad1983@gmail.com"
   },
   "company":{
      "domain":null,
      "name":"Operi productions",
      "image":null,
      "ctype":"company",
      "phone":null,
      "address":null,
      "id":10121
   },
   "deal":{
      "id":3207,
      "ctype":"deal",
      "dealname":"Operi"
   },
   "activity_due_on":"2016-05-28",
   "due_time":null,
   "act_on":"2016-05-28T00
:00:00",
   "add_next":false,
   "title":"Email",
   "note":null,
   "due_date":"2016-05-28",
   "duration":null,
   "is_completed":false,
   "completed_on":null,
   "is_trashed":false
}

Returns

If the call succeeds, it will return the activity object with updated data.

Delete Activity

DELETE api/crm/activities/{activity_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

Contacts

People Object

{
   "id":7499,
   "email":"bonnie@positivelyentertainment.com",
   "first_name":"",
   "last_name":"",
   "phone":null,
   "full_name":"bonnie@positivelyentertainment.com",
   "job_title":null,
   "owner":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.com/image.jpg",
      "id":1,
      "full_name":"Sathish
 Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "company":{
      "domain":null,
      "name":"adhome",
      "image":null,
      "ctype":"company",
      "phone":null,
      "address":null,
      "id":10116
   },
   "created_by":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.com/image.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "created_on":"2015-12-23T07:51:45.948099Z",
   "tags":null,
   "custom_fields":null
}
Attribute Description
id (integer) Contact ID
email (string) email address
first_name (string) first name of the contact
last_name (string) last name of the contact
phone (string) phone number of the contact
full_name (string) full name of the contact
job_title (string) Designation
owner (object) owner info
company (object) company details
created_by (object) creator of the contact
created_on (string) datetime of the creation
tags (string) tag names given for the contact
custom_fields (object) all custom fields for the CRM contacts

Create People

POST api/contacts/people HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
Sample Request
{
   "custom_fields":{
      "25":{
         "field_type":"text",
         "name":"Deal",
         "key":"deal",
         "options":[
         ],
         "value":"Test"
      },
      "26":{
         "field_type":"date",
         "name":"Date",
         "key":"date",
         "options":null,
         "value":"2016-07-08"
      }
   },
   "owner":1,
   "first_name":"Ajith",
   "last_name":"Paul",
   "email":"ajithpaul@adhome.com",
   "phone":"9995584542",
   "job_title":"SW",
   "companyName":"adhome"
}
Sample Response
{
   "id":17784,
   "email":"ajithp@adhome.com",
   "first_name":"Ajith",
   "last_name":"Paul",
   "phone":"8452145555",
   "full_name":"Ajith Paul",
   "job_title":"SW",
   "owner":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.com/image.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "company":{
      "domain":"sdfzsdfdsf.com",
      "name":"adhome",
      "image":null,
      "ctype":"company",
      "phone":"894fd646",
      "address":"sdfsdfsdf",
      "id":10207
   },
   "created_by":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.com/image.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "created_on":"2016-07-18T12:40:48.810179Z",
   "tags":null,
   "custom_fields":{
      "25":{
         "field_type":"text",
         "name":"Deal",
         "value":"Test Deal",
         "key":"deal",
         "options":[
         ],
         "is_add_field":true
      },
      "26":{
         "field_type":"date",
         "name":"Date",
         "value":"2016-07-06",
         "key":"date",
         "options":null,
         "is_add_field":true
      }
   }
}

Returns

If call succeeds, it will send the people object back.

Update People

PUT api/contacts/people/{contact_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
Sample Request
{
   "id":17782,
   "email":"ajithpaul@adhome.com",
   "first_name":"Ajith",
   "last_name":"Paul M",
   "phone":"4568595442",
   "full_name":"Ajith Paul",
   "job_title":"SW",
   "owner":1,
   "company":10224,
   "created_by":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.com/image.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "created_on":"2016-07-18T12:28:02.165162Z",
   "tags":null,
   "custom_fields":{
      "25":{
         "field_type":"text",
         "name":"Deal",
         "value":"Test",
         "key":"deal",
         "options":[
         ],
         "is_add_field":true
      },
      "26":{
         "field_type":"date",
         "name":"Date",
         "value":"2016-07-07T18:30:00.000Z",
         "key":"date",
         "options":null,
         "is_add_field":true
      }
   }
}
Sample Response
{
   "id":17782,
   "email":"ajithpaul@adhome.com",
   "first_name":"Ajith",
   "last_name":"Paul M",
   "phone":"4568595442",
   "full_name":"Ajith Paul M",
   "job_title":"SW",
   "owner":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.com/image.jpg",
      "id":1,
      "full_name":"SathishVenkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "company":{
      "domain":null,
      "name":"adhome",
      "image":null,
      "ctype":"company",
      "phone":null,
      "address":null,
      "id":10224
   },
   "created_by":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.com/image.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "created_on":"2016-07-18T12:28:02.165162Z",
   "tags":null,
   "custom_fields":{
      "25":{
         "field_type":"text",
         "name":"Deal",
         "value":"Test",
         "key":"deal",
         "options":[
         ],
         "is_add_field":true
      },
      "26":{
         "field_type":"date",
         "name":"Date",
         "value":"2016-07-07T18:30:00.000Z",
         "key":"date",
         "options":null,
         "is_add_field":true
      }
   }
}

Returns

If call succeeds, it will return the contacts object.

Delete People

DELETE api/contacts/people/{contact_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

Returns

If the call succeeds, the contact will be removed from the list.

Organization Object

  {
     "id":18,
     "domain":null,
     "name":"",
     "address":null,
     "phone":null,
     "created_by":{
        "url":"/users/1",
        "image":"https://twprofile.s3.amazonaws.com/image.jpg",
        "id":1,
        "full_name":"Sathish Venkat",
        "email":"sathish@adhome.com",
        "label_txt":"SV"
     },
     "owner":{
        "url":"/users/1",
        "image":"https://twprofile.s3.amazonaws.com/image.jpg",
        "id":1,
        "full_name":"Sathish Venkat",
        "email":"sathish@adhome.com",
        "label_txt":"SV"
     },
     "created_on":"2015-08-29T14:49:13.838853Z",
     "people":0,
     "deals":1,
     "tags":null,
     "custom_fields":null
  }
Attribute Description
id (integer) Organization ID
domain (string) domain used by the organization
name (string) name of organization
address (string) address of organization
phone (string) phone number
created_by (object) organization added-by user details
owner (object) owner details
created_on (string) creation date
people (integer)(integer) total people added to the organization
deals (integer) total deals added
tags (string) tags related to organization
custom_fields (object) custom fields added to the organization add-form

Create Organization

POST api/contacts/companies HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
Sample Request
{
   "custom_fields":{
      "25":{
         "field_type":"text",
         "name":"Test",
         "key":"test",
         "options":null,
         "value":"Custom
 field"
      },
      "26":{
         "field_type":"text",
         "name":"Test 123",
         "key":"test-123",
         "options":null,
         "value":"Custom
 field2"
      }
   },
   "owner":274,
   "name":"Twitter",
   "domain":"twitter.com",
   "address":"1502/22 Twitter Inc",
   "phone":"245112212454"
}
Sample Response
{
   "id":10231,
   "domain":"twitter.com",
   "name":"Twitter",
   "address":"1502/22 Twitter Inc",
   "phone":"245112212454",
   "created_by":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.com/image.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "owner":{
      "url":"/users/274",
      "image":"https://twprofile.s3.amazonaws.com/image.jpg",
      "id":274,
      "full_name":"Ajith Paul",
      "email":"ajith.paul@adhome.com",
      "label_txt":"AP"
   },
   "created_on":"2016-07-19T07:26:57.157037Z",
   "people":0,
   "deals":0,
   "tags":null,
   "custom_fields":{
      "25":{
         "field_type":"text",
         "name":"Test",
         "value":"Custom field",
         "key":"test",
         "options":null,
         "is_add_field":true
      },
      "26":{
         "field_type":"text",
         "name":"Test 123",
         "value":"Custom field2",
         "key":"test-123",
         "options":null,
         "is_add_field":true
      }
   }
}

Update Organization

PUT api/contacts/companies/{organization_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
Sample Request
{
   "id":10231,
   "domain":"twitter.com",
   "name":"Twitter",
   "address":"1502/22 Twitter Inc",
   "phone":"40015222542323",
   "created_by":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.com/image.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "owner":274,
   "created_on":"2016-07-19T07:26:57.157037Z",
   "people":0,
   "deals":0,
   "tags":null,
   "custom_fields":{
      "25":{
         "field_type":"text",
         "name":"Test",
         "value":"Custom field1",
         "key":"test",
         "options":null,
         "is_add_field":true
      },
      "26":{
         "field_type":"text",
         "name":"Test 123",
         "value":"Custom field2",
         "key":"test-123",
         "options":null,
         "is_add_field":true
      }
   }
}

Sample Response “`

{
   "id":10231,
   "domain":"twitter.com",
   "name":"Twitter",
   "address":"1502/22 Twitter Inc",
   "phone":"40015222542323",
   "created_by":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.com/image.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "owner":{
      "url":"/users/274",
      "image":"https://twprofile.s3.amazonaws.com/image.jpg",
      "id":274,
      "full_name":"Ajith Paul",
      "email":"ajith.paul@adhome.com",
      "label_txt":"AP"
   },
   "created_on":"2016-07-19T07:26:57.157037Z",
   "people":0,
   "deals":0,
   "tags":null,
   "custom_fields":{
      "25":{
         "field_type":"text",
         "name":"Test",
         "value":"Custom field1",
         "key":"test",
         "options":null,
         "is_add_field":true
      },
      "26":{
         "field_type":"text",
         "name":"Test 123",
         "value":"Custom field2",
         "key":"test-123",
         "options":null,
         "is_add_field":true
      }
   }
}

Delete Organisation

DELETE api/contacts/companies/{organization_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

HRMS

HRMS provides various HRM related operations using the /hrm resource and related sub-resources. Use HRM for managing new employees, timeoff, and automatic check-ins. You can also use sub-resources to get employees, timeoff, tasks and automatic check-ins related details.

Time Off Policy

Time off Policy Object

GET /api/hrm/organization/settings/timeoff-policy/{timeoff_policy_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
   "id":51,
   "name":"Sick leave policy",
   "policy_effective_date":"2016-03-01",
   "total_timeoff":21,
   "schedule":51,
   "timeoff_interval":1,
   "is_public":true,
   "timeoff_type":"D",
   "timeoff_disply_type":"D",
   "day_hours":8,
   "policy_renew_type":"YF",
   "total_employees":10,
   "modified_on":"2016-06-10T11:10:53.824171Z",
   "is_active":false,
   "is_default":false,
   "assigned_users":[
      {
         "id":19,
         "label_txt":"rt",
         "image":null,
         "full_name":"rajmohan",
         "email":"rajmohantestmail@gmail.com",
         "upcoming_birthday":null
      },
      {
         "id":74,
         "label_txt":"Ac",
         "image":null,
         "full_name":"Aravind cse",
         "email":"arvindcse2014@gmail.com",
         "upcoming_birthday":null
      },
      {
         "id":76,
         "label_txt":"GY",
         "image":null,
         "full_name":"Geo Yahoo",
         "email":"geojacobm6@yahoo.com",
         "upcoming_birthday":null
      },
      {
         "id":72,
         "label_txt":"ym",
         "image":null,
         "full_name":"yolanda messina",
         "email":"yolandamessina364@gmail.com",
         "upcoming_birthday":null
      },
      {
         "id":201,
         "label_txt":"GJ",
         "image":null,
         "full_name":"Geo Jacob",
         "email":"geo.jacob11@adhome.com",
         "upcoming_birthday":null
      },
      {
         "id":1,
         "label_txt":"SV",
         "image":"https://twprofile.s3.amazonaws.com/usersuser-8011f79c-007c-4943-a968-1d13dd13b1d9-image.jpg",
         "full_name":"Sathish Venkat",
         "email":"sathish@adhome.com",
         "upcoming_birthday":null
      }
   ]
}
Attribute Description
id (integer) ID of the policy
name (string) name of the policy
policy_effective_date (string) policy effective-from date
total_timeoff (integer) total number of timeoff
schedule (integer) schedule ID
timeoff_interval (integer) days after which new employee can apply for timeoff
timeoff_type (string) timeoff displayed in days (’D’) and displayed in hours (‘H’)
timeoff_display_type (string) timeoff displayed in days (’D’) and displayed in hours ('H’)
day_hours (integer) hours of work per day
policy_renew_type (string) Policy renewal type- first of every year ('YF’) or half year ('YH’)
total_employees (integer) total number of employees
modified_on (string) date of modification
is_active (boolean) is the policy active
is_default (boolean) is the policy default for the organization
assigned_users (array of objects) assigned user details

Assigned Users Object

Attribute Description
id (integer) ID for the user
label_txt (string) label text for avatar
image (string) image url for the profile picture
full_name (string) full name of the user
email (string) email ID
upcoming_birthday (string) Next birthday of this user

Create Time off Policy

POST /api/hrm/organization/settings/timeoff-policy HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
Sample Request
{
   "name":"Test Policy DS",
   "total_timeoff":15,
   "policy_effective_date":"2016-07-13",
   "policy_renew_type":"YF",
   "day_hours":9,
   "timeoff_interval":20
}
Sample Response
{
   "id":76,
   "name":"Test Policy DS",
   "policy_effective_date":"2016-07-13",
   "total_timeoff":15,
   "schedule":76,
   "timeoff_interval":20,
   "is_public":true,
   "timeoff_type":"D",
   "timeoff_disply_type":"D",
   "day_hours":9,
   "policy_renew_type":"YF",
   "total_employees":0,
   "modified_on":"2016-07-12T07:58:46.687121Z",
   "is_active":true,
   "is_default":false,
   "assigned_users":[

   ]
}

Create new Time off Policy.

Attribute Description
name (string) Name of the Time off policy
total_timeoff (integer) total number of timeoff
policy_effective_date (date string) policy effective from date
policy_renew_type (string) time of renewal of policy
day_hours (string) total work hours per day
timeoff_interval (integer) number of days after which new hire can apply for leave

Returns

If the call succeeds, the timeoff policy object is returned with all the information about the timeoff policy.

Update Time Off Policy

PATCH /api/hrm/organization/settings/timeoff-policy/{timeoff_policy_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
Sample Request
{
   "id":71,
   "name":"test",
   "policy_effective_date":"2016-05-31",
   "total_timeoff":30,
   "schedule":71,
   "timeoff_interval":15,
   "is_public":true,
   "timeoff_type":"D",
   "timeoff_disply_type":"D",
   "day_hours":9,
   "policy_renew_type":"YF",
   "total_employees":3,
   "modified_on":"2016-06-02T12:32:24.887566Z",
   "is_active":false,
   "is_default":false,
   "assigned_users":[
      {
         "id":202,
         "label_txt":"GT",
         "image":null,
         "full_name":"Geo Test 12",
         "email":"geo.jacob12@adhome.com",
         "upcoming_birthday":null
      },
      {
         "id":76,
         "label_txt":"GY",
         "image":null,
         "full_name":"Geo Yahoo",
         "email":"geojacobm6@yahoo.com",
         "upcoming_birthday":null
      },
      {
         "id":77,
         "label_txt":"Go",
         "image":null,
         "full_name":"Geo outlook",
         "email":"geojacobm6@outlook.com",
         "upcoming_birthday":null
      }
   ]
}
Sample Response
{
   "id":71,
   "name":"test",
   "policy_effective_date":"2016-05-31",
   "total_timeoff":30,
   "schedule":71,
   "timeoff_interval":15,
   "is_public":true,
   "timeoff_type":"D",
   "timeoff_disply_type":"D",
   "day_hours":9,
   "policy_renew_type":"YF",
   "total_employees":3,
   "modified_on":"2016-07-25T07:04:23.225067Z",
   "is_active":false,
   "is_default":false,
   "assigned_users":[
      {
         "id":202,
         "label_txt":"GT",
         "image":null,
         "full_name":"Geo Test 12",
         "email":"geo.jacob12@adhome.com",
         "upcoming_birthday":null
      },
      {
         "id":76,
         "label_txt":"GY",
         "image":null,
         "full_name":"Geo Yahoo",
         "email":"geojacobm6@yahoo.com",
         "upcoming_birthday":null
      },
      {
         "id":77,
         "label_txt":"Go",
         "image":null,
         "full_name":"Geo outlook",
         "email":"geojacobm6@outlook.com",
         "upcoming_birthday":null
      }
   ]
}

Returns

If the call succeeds, the timeoff policy object is returned with all the information about the updated timeoff policy.

Delete Time Off Policy

DELETE /api/hrm/organization/settings/timeoff-policy/{timeoff_policy_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

Time Off Requests

GET /api/hrm/people/{id}/time-off-request HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
[
   {
      "id":208,
      "start_date":"2016-06-22",
      "end_date":"2016-06-24",
      "time_off_policy":1,
      "status":"AP",
      "modified_on":"2016-06-22T11:57:19.317340Z",
      "act_on":"2016-06-22T11:57:19.294813Z",
      "comment":"this is a leave application",
      "modified_by":{
         "url":"/users/1",
         "image":"https://pexels.com/image.jpg",
         "id":1,
         "full_name":"Sathish Venkat",
         "email":"sathish@adhome.com",
         "label_txt":"SV"
      },
      "days_of_leave":3.0,
      "activities":[
         {
            "id":443,
            "act_on":"2016-06-22T11:57:36.295290Z",
            "action_type":"replied",
            "action_field":"comment",
            "verb":"replied",
            "class_name":"replied",
            "organization_id":1,
            "created_on":"2016-06-22T11:57:36.295290Z",
            "is_deleted":false,
            "actor":{
               "url":"/users/1",
               "image":"https://example.com/image.jpg",
               "id":"1",
               "email":"sathish@adhome.com",
               "full_name":"Sathish Venkat",
               "label_txt":"SV"
            },
            "action_obj":{
               "id":"208",
               "ctype":"employeetimeoff"
            },
            "source_obj":{
               "comment_detail":"hello test",
               "id":"126",
               "ctype":"hrmcomment"
            },
            "target_obj":null
         },
         {
            "id":444,
            "act_on":"2016-06-22T11:57:47.566159Z",
            "action_type":"replied",
            "action_field":"comment",
            "verb":"replied",
            "class_name":"replied",
            "organization_id":1,
            "created_on":"2016-06-22T11:57:47.566159Z",
            "is_deleted":false,
            "actor":{
               "url":"/users/1",
               "image":"https://example.com/image.jpg",
               "id":"1",
               "email":"sathish@adhome.com",
               "full_name":"Sathish Venkat",
               "label_txt":"SV"
            },
            "action_obj":{
               "id":"208",
               "ctype":"employeetimeoff"
            },
            "source_obj":{
               "comment_detail":"hello test2",
               "id":"127",
               "ctype":"hrmcomment"
            },
            "target_obj":null
         }
      ],
      "can_approve":true,
      "created_by":{ 
         "url":"/users/274",
         "image":"https://example.com/mage.jpg",
         "id":274,
         "full_name":"Ajith Paul",
         "email":"ajith.paul@adhome.com",
         "label_txt":"AP"
      },
      "created_on":"2016-06-22T11:57:19.296021Z",
      "policy_detail":{
         "is_expired":false,
         "id":1,
         "name":"adhome"
      },
      "entered_by":{
         "url":"/users/1",
         "image":"https://example.com/image.jpg",
         "id":1,
         "full_name":"Sathish Venkat",
         "email":"sathish@adhome.com",
         "label_txt":"SV"
      },
      "is_entered":true
   }
]

API endpoint for the list of all time-off requests made by the employee.

Attribute Description
id (integer) request ID number
start_date (string) timeoff starting date
end_date (string) timeoff ending date
time_off_policy (integer) policy ID number
status (string) status of the timeoff(approved)
modified_on (string) datetime on which modified
act_on (string) datetime of Action to timeoff(approve or reject)
comment (string) comment on the timeoff
modified_by (object) details of the person who modified the timeoff request
days_of_leave (integer) number of days of leave applied
activities (object) array of all activities of the request
can_approve (boolean) possible to approve or not
created_by (object) Details about the creator of the request
created_on (string) date-time of the creation
policy_detail (object) Info on the policy (id,name ..)
entered_by (object) details about the user who entered the timeoff
is_entered (boolean) is the timeoff entered (timeoff entered by admin or owner)

User Object

Attribute Description
url (string) url of the profile
image (string) url of the profile image
id (integer) ID of the employee
full_name (string) full name of the user
email (string) email address of the user
label_txt (string) label text for profile default avatar

Policy Detail Object

Attribute Description
is_expired (boolean) is the policy expired
id (integer) ID number of the policy
name (string) name of the policy

Activities Object

Attribute Description
id (integer) ID of the activity
act_on (string) datetime of the activity
action_type (string) type of activity
action_field (string) field type of the activity
verb (string) verb text for displaying of the activity
class_name (string) class name for the acitivity
organization_id Organization ID number
created_on (string) datetime of the creation of the activity
is_deleted (boolean) whether the activity is deleted
actor (object) user who added the activity(comment,..)
action_obj (object) object to understand context of activity
source_obj (object) activity data (comment details)

Action Object

Attribute Description
id (integer) ID of the activity
ctype (string) type of the activity applying to

Source Object

Atribute Description
comment_detail (string) comment text
id (integer) comment ID number
ctype (string) type of comment

Returns

Returns the object with all the information about the employee time off.

Create Time Off Request

Sample Request
POST /api/hrm/people/{id}/time-off-request HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
   "start_date":"2016-07-12",
   "end_date":"2016-07-12",
   "time_off_policy":1,
   "comment":"test timeoff"
}
Sample Response
{
   "id":208,
   "start_date":"2016-06-22",
   "end_date":"2016-06-24",
   "time_off_policy":1,
   "status":"AP",
   "modified_on":"2016-06-22T11:57:19.317340Z",
   "act_on":"2016-06-22T11:57:19.294813Z",
   "comment":"this is a leave application",
   "modified_by":{
      "url":"/users/1",
      "image":"https://pexels.com/image.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "days_of_leave":3.0,
   "activities":[
      {
         "id":443,
         "act_on":"2016-06-22T11:57:36.295290Z",
         "action_type":"replied",
         "action_field":"comment",
         "verb":"replied",
         "class_name":"replied",
         "organization_id":1,
         "created_on":"2016-06-22T11:57:36.295290Z",
         "is_deleted":false,
         "actor":{
            "url":"/users/1",
            "image":"https://example.com/image.jpg",
            "id":"1",
            "email":"sathish@adhome.com",
            "full_name":"Sathish Venkat",
            "label_txt":"SV"
         },
         "action_obj":{
            "id":"208",
            "ctype":"employeetimeoff"
         },
         "source_obj":{
            "comment_detail":"hello test",
            "id":"126",
            "ctype":"hrmcomment"
         },
         "target_obj":null
      },
      {
         "id":444,
         "act_on":"2016-06-22T11:57:47.566159Z",
         "action_type":"replied",
         "action_field":"comment",
         "verb":"replied",
         "class_name":"replied",
         "organization_id":1,
         "created_on":"2016-06-22T11:57:47.566159Z",
         "is_deleted":false,
         "actor":{
            "url":"/users/1",
            "image":"https://example.com/image.jpg",
            "id":"1",
            "email":"sathish@adhome.com",
            "full_name":"Sathish Venkat",
            "label_txt":"SV"
         },
         "action_obj":{
            "id":"208",
            "ctype":"employeetimeoff"
         },
         "source_obj":{
            "comment_detail":"hello test2",
            "id":"127",
            "ctype":"hrmcomment"
         },
         "target_obj":null
      }
   ],
   "can_approve":true,
   "created_by":{
      "url":"/users/274",
      "image":"https://example.com/mage.jpg",
      "id":274,
      "full_name":"Ajith Paul",
      "email":"ajith.paul@adhome.com",
      "label_txt":"AP"
   },
   "created_on":"2016-06-22T11:57:19.296021Z",
   "policy_detail":{
      "is_expired":false,
      "id":1,
      "name":"adhome"
   },
   "entered_by":{
      "url":"/users/1",
      "image":"https://example.com/image.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "is_entered":true
}

Create a new request for applying for timeoff.

Returns

This call, if succeeded will return the timeoff request object.

Update Time Off Request

Sample Request
PATCH /api/hrm/people/{id}/time-off-request/{id}(requestID) HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
   "id":219,
   "start_date":"2016-07-13",
   "end_date":"2016-07-13",
   "time_off_policy":1,
   "status":"AP",
   "modified_on":"2016-07-12T09:42:45.324789Z",
   "act_on":"2016-07-12T09:42:45.301599Z",
   "comment":"test 123",
   "modified_by":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.com/users/user-77abb729-773e-41f5-9244-4a5fd337bdba-image
.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "days_of_leave":1,
   "activities":[

   ],
   "can_approve":true,
   "created_by":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws
.com/users/user-77abb729-773e-41f5-9244-4a5fd337bdba-image.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "created_on":"2016-07-12T09:42:45.303024Z",
   "policy_detail":{
      "is_expired":false,
      "id":1,
      "name":"adhome"
   },
   "entered_by":{
      "url":"/users/1",
      "image":"https://twprofile
.s3.amazonaws.com/users/user-77abb729-773e-41f5-9244-4a5fd337bdba-image.jpg",
      "id":1,
      "full_name":"Sathish
 Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "is_entered":true,
   "statusLabel":"Approved",
   "editMode":true
}

Returns

If the call succeeds, it will return an time off request with two extra fields, ‘statusLabel’ and 'editMode’ and without activities object.

Attribute Description
statusLabel (string) if the request is approved it will show “approved”
editMode (boolean) if the request has been edited, it will be true.

Cancel Time Off Request

Sample Request 
PUT /api/hrm/people/{id}/time-off-request/cancel HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

Employees

Returns a list of all Employees associated with a specific Organization.

HTTP Request

The list contains only employees who are ACTIVE.

Employee Object

GET /api/hrm/people/{profile_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
    "id": 11,
    "first_name": "aravind",
    "last_name": "dsSpring",
    "is_owner": false,
    "label_txt": "ad",
    "is_admin": false,
    "is_hrm_admin": false,
    "is_active": true,
    "last_login": "2016-06-22T08:26:52.555870Z",
    "company": "Dsqqqqqqq",
    "full_name": "aravind dsSpring",
    "image": null,
    "job_title": "Developer",
    "organization": {
        "id": 1,
        "name": "Dsqqqqqqq",
        "domain": "adhome",
        "logo": "http://pexels.com/img.png",
        "email": "geo.jacob@adhome.com",
        "tenant_domain": "adhome.com",
        "created_on": "2015-03-10",
        "default_currency": "USD",
        "default_currency_symbol": "$",
        "label_txt": null,
        "orgkey": "Dsq"
    },
    "about": null,
    "employee_id": 42,
    "emp_type": null
}

HTTP Request

Attribute Description
id (integer) Employee Profile ID
first_name (string) Employee first name
last_name (string) Employee Last name
is_owner (boolean) If user is Owner of the company
label_txt (string) Label text for profile avatar
is_admin (boolean) if Employee is Administrator
is_hrm_admin (boolean) if Employee is HRM Administrator
is_active (boolean) if Employee is Active or not
last_login (datefield) last time logged in time
company (String) Organisation Name
full_name (String) Employee full name
image (String) url of the profile image
job_title (String) Job Title/Designation
organisation (object) Company Data
about (String) Short description of the employee
employee_id (integer) Employee ID Number
emp_type (String) Employee Type (Fulltime,Parttime,..)

Organisation object

Attribute Description
id (integer) ID for the organisation
name (string) Name of the organisation
domain (string) domain of the organisation
logo (string) url for the company logo
email (string) Email address of the organisation
tenant_domain (string) tenant domain address
created_on (string) date on which organisation was created
default_currency (string) currency used by the organisation
default_currency_symbol (string) Symbol used for currency
label_txt (string) label text for profile default avatar
orgkey (string) organisation key

Retrieve an Employee

GET api/hrm/people/{profile_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

Retrieve an employee using the unique ID of the employee.

Returns

Employee object, else throws an error.

Create Employee

Creates an employee object

GET /api/users HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
Sample Request
{
   "first_name":"Himesh",
   "last_name":"khan",
   "verified":true,
   "verifying":true,
   "error":false,
   "msg":"",
   "email":"himesh@adhome.com",
   "job_title":"SW",
   "time_zone":"Europe/Kaliningrad"
}
Sample Response
{
   "id":282,
   "first_name":"Himesh",
   "last_name":"khan",
   "email":"himesh@adhome.com",
   "job_title":"SW",
   "last_login":null,
   "organization":1,
   "is_admin":false,
   "company":"adhome",
   "image":null,
   "first_letter":"H",
   "full_name":"Himesh khan",
   "google_token":{
      "g_refresh_token":null,
      "g_acces_token":null
   },
   "is_hrm_admin":false,
   "project_access":[

   ],
   "is_owner":false,
   "label_txt":"Hk",
   "is_active":true,
   "time_zone":"Europe/Kaliningrad"
}
Attribute Description
first_name (string) first name of the new employee
last_name (string) last name of the new employee
is_admin (boolean) the new employee to have admin privileges
email (string) email address of the employee
job_title (string) designation of the employee
time_zone (string) Time Zone of the employee

Returns

The employee object will be returned if the call succeeded. If any of the above attributes are invalid, the call will throw an error.

Update Employee

PATCH /api/hrm/{profile_id}/profile HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
Sample Request
{
   "id":224,
   "user":{
      "id":274,
      "first_name":"Ajith",
      "last_name":"Paul M",
      "is_active":true,
      "job_title":"Developer",
      "time_zone":"Asia/Kolkata",
      "about":null,
      "full_name":"Ajith Paul",
      "label_txt":"AP",
      "email":"ajith.paul@adhome.com",
      "is_owner":false,
      "is_admin":false,
      "is_crm_admin":false,
      "is_hrm_admin":true,
      "report_to":11,
      "owner":{
         "url":"/users/1",
         "image":"https://pixels.com/e.jpg",
         "id":1,
         "full_name":"Sathish Venkat",
         "email":"sathish@adhome.com",
         "label_txt":"SV"
      }
   },
   "emp_type":"FT",
   "start_date":"2016-05-13",
   "accuracy":20,
   "last_date":null,
   "job_description":null,
   "policy":false,
   "emp_id":"do10048"
}
Sample Response
{
   "id":224,
   "user":{
      "id":274,
      "first_name":"Ajith",
      "image":"https://pixels.com/image.jpg",
      "last_name":"Paul M",
      "is_active":true,
      "job_title":"Developer",
      "time_zone":"Asia/Kolkata",
      "about":null,
      "full_name":"Ajith Paul M",
      "label_txt":"AP",
      "email":"ajith.paul@adhome.com",
      "is_owner":false,
      "is_admin":false,
      "is_crm_admin":false,
      "is_hrm_admin":true,
      "report_to":{
         "url":"/users/11",
         "image":"http://pixels.com/image.jpg",
         "id":11,
         "full_name":"Aravind dsSpring",
         "email":"aravind@adhome.com",
         "label_txt":"AD"
      },
      "owner":{
         "url":"/users/1",
         "image":"https://pixels.com/image.jpg",
         "id":1,
         "full_name":"Sathish Venkat",
         "email":"sathish@adhome.com",
         "label_txt":"SV"
      },
   },
   "emp_type":"FT",
   "start_date":"2016-05-13",
   "accuracy":20,
   "last_date":null,
   "job_description":null,
   "policy":false,
   "emp_id":"do10048"
}
Attribute Description
id (integer) ID for the employee
emp_id (integer) employee ID card number
emp_type (String) Employee Type (Fulltime,Parttime,..)
policy (boolean) is policy is activated for the specific employee
start_date (string) joining date of the employee
last_date (string) date on which employee left the company
accuracy (integer) the value for displaying profile completion
job_description (string) short description of employee’s job.
user (object) user data

user object

Attribute Description
id (integer) Employee Profile ID
about (string) short description about the employee (comes under Bio)
email (string) email address of the employee
first_name (string) Employee first name
last_name (string) Employee Last name
is_admin (boolean) Employee is Administrator or not
is_hrm_admin (boolean) Employee is HRM Administrator or not
is_active (boolean) Employee is Active or not
is_crm_admin (boolean) Employee is CRM admin or not
is_owner (boolean) user is owner of the company
label_txt (string) Label text for profile avatar
job_title (String) Job Title/Designation
owner (object) owner info

Returns

If the call succeeds, it will return the employee object. Else it will return error for invalid attribute values.

Documents

Document Object

{
    "id": 85,
    "title": "images_004.jpeg",
    "attachment": "https://mediatw.s3.amazonaws.com/hrm/1466509302976_images_004.jpeg?Signature=Fx1mcacqtpi%2B7YpbIY5LejDFLjc%3D&Expires=1469185988&AWSAccessKeyId=AKIAJ3L5LCTCJXCFVTYA",
    "is_drivebox": false,
    "is_trashed": false,
    "modified_by": {
        "id": 1,
        "label_txt": "s",
        "image": "https://twprofile.s3.amazonaws.com/users/user-61ddc395-8145-493c-a72f-df70ac205783-image.jpg",
        "full_name": "sathish",
        "email": "sathish@adhome.com",
        "upcoming_birthday": "2017-03-15"
    },
    "size": "4612",
    "created_by": {
        "id": 1,
        "label_txt": "s",
        "image": "https://twprofile.s3.amazonaws.com/users/user-61ddc395-8145-493c-a72f-df70ac205783-image.jpg",
        "full_name": "sathish",
        "email": "sathish@adhome.com",
        "upcoming_birthday": "2017-03-15"
    },
    "thumbnail": null,
    "directory": 59,
    "is_live": true,
    "ext": "jpeg",
    "download_url": "http://192.168.1.51:8000/hrm/files/download/85",
    "created_on": "2016-06-21",
    "tags": [],
    "is_shared": false
}
Attribute Description
id (integer) Identificatoin number of the file
title (string) Title of the file
attachment (string) URl of the file
is_drivebox (boolean) Status to check file is from drivebox(google drive or drop box) or not
is_trashed (boolean) Status to check Cfile is trashed or not
modified_by (object) user object who modified the file
size (string) Size of the file
created_by (object) user who created the file
thumbnail (string) URL of the file’s thumbnail
directory (integer) Identificatoin number of the files’s directory
is_live (boolean) Status to check file is live or not
ext (string) Extension type of the file
download_url (string) URL to download the file
created_on (date) date on which the file is created
tags (array) tags belongs to the file.
is_shared (boolean) Status to check file is shared or not

Create Document

POST api/hrm/people/{people_id}/files HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
    "title":"images_007.jpeg",
    "attachment":"hrm/1469182994232_images_007.jpeg",
    "ext":"jpeg",
    "directory":59,
    "file_size":7218,
    "is_shared":false,
    "is_live":false
 }

Activate Document

PATCH api/hrm/people/{people_id}/files/activate HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
    "file_ids":[234],
    "is_shared":true
}

Delete Document

DELETE api/hrm/people/{people_id}/files/{file_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

Tasks

Lists all the tasks assigned to the employee

Task Object

GET api/hrm/people/{id}/tasks HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
  "id":141,
  "title":"Task to aravind",
  "description":"Finish it",
  "created_on":"2016-01-14T12:21:47.924548Z",
  "due_date":null,
  "assigned_to":{
     "user_id":11,
     "id":32,
     "full_name":"Aravind dsSpring"
  },
  "related_to":null,
  "task_type":"G",
  "timeoff_id":"None",
  "can_edit":true,
  "created_by":{
     "url":"/users/1",
     "image":"https://twprofile.s3.amazonaws.com/image.jpg",
     "id":1,
     "full_name":"SathishVenkat",
     "email":"sathish@adhome.com",
     "label_txt":"SV"
  },
  "task_url":"tasks/11",
  "default_policy_id":null
}
Attribute Description
id ID of the task
title (string) task title
description (string) Description of the task to be completed
created_on (string) creation date
due_date (string) Date before task needs to be completed
assigned_to (object) task assigned to employee details
task_type (string) Type of task (‘G’ for general task,..)
timeoff_id timeoff id for timeoff task
can_edit if task can be edited
created_by (object) info about the creator of the task
task_url (string) url of the task
default_policy_id (integer) default policy ID

Create Task

Sample Request
POST api/hrm/people/{id}/tasks HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
   "title":"Test task",
   "assigned_to":224,
   "due_date":"2016-07-01",
   "description":"This is a test task."
}
Sample Response
{
   "id":297,
   "title":"Test task",
   "description":"This is a test task.",
   "created_on":"2016-07-13T06:11:24.679141Z",
   "due_date":"2016-07-01",
   "assigned_to":{
      "user_id":274,
      "id":224,
      "full_name":"Ajith Paul M"
   },
   "related_to":null,
   "task_type":"G",
   "timeoff_id":"None",
   "can_edit":true,
   "created_by":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.com/image.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "task_url":"tasks/274",
   "default_policy_id":null
}

Update Task

Sample Request
PUT api/hrm/people/{profile_id}/tasks/{task_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
   "id":297,
   "title":"Test tasks",
   "description":"This is a test task.",
   "created_on":"2016-07-13T06:11:24.679141Z",
   "due_date":"2016-07-06",
   "assigned_to":8,
   "related_to":null,
   "task_type":"G",
   "timeoff_id":"None",
   "can_edit":true,
   "created_by":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.com/image.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "task_url":"tasks/274",
   "default_policy_id":null
}
Sample Response
{
   "id":297,
   "title":"Test tasks",
   "description":"This is a test task.",
   "created_on":"2016-07-13T06:11:24.679141Z",
   "due_date":"2016-07-06",
   "assigned_to":{
      "user_id":96,
      "id":8,
      "full_name":"alok vats"
   },
   "related_to":null,
   "task_type":"G",
   "timeoff_id":"None",
   "can_edit":true,
   "created_by":{
      "url":"/users/1",
      "image":"https://twprofile.s3.amazonaws.com/image.jpg",
      "id":1,
      "full_name":"Sathish Venkat",
      "email":"sathish@adhome.com",
      "label_txt":"SV"
   },
   "task_url":"tasks/96",
   "default_policy_id":null
}

Returns

If the call succeeds, it will return the task object. If any of the fields have invalid values, it will throw an error.

Delete Task

Sample Request
DELETE api/hrm/people/{profile_id}/tasks/{task_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

Automatic Check-ins

Automatic Check-ins Object

Samle Object
{
   "id":34,
   "question":"This  is a checkin question",
   "is_active":true,
   "is_public":true,
   "created_by":1,
   "schedule_day":"EFR",
   "schedule_time":"ED",
   "people_count":2,
   "assigned_to":[
      {
         "id":30,
         "emp_type":null,
         "start_date":"2015-10-26",
         "job_description":null,
         "job_title":"dev",
         "user":{
            "url":"/users/201",
            "image":"",
            "id":201,
            "full_name":"Geo Jacob",
            "email":"geo.jacob11@adhome.com",
            "label_txt":"GJ"
         }
      },
      {
         "id":224,
         "emp_type":"FT",
         "start_date":"2016-05-13",
         "job_description":null,
         "job_title":"Developer",
         "user":{
            "url":"/users/274",
            "image":"https://twprofile.s3.amazonaws.com/image.jpg",
            "id":274,
            "full_name":"Ajith Paul",
            "email":"ajith.paul@adhome.com",
            "label_txt":"AP"
         }
      }
   ],
   "created_on":"2016-07-13T09:59:44.840079Z",
   "scheduled_on":null,
   "is_responded":true
}
Attribute Description
id (integer) ID for the checkin
question (string) question text
is_active (boolean) if the checkin is active
is_public (boolean) the checkin is public or private
created_by (integer) ID of the creator of the checkin
schedule_day (string) day on which checkin mail will be sent
schedule_time (string) time of the day, to send the mail
people_count (integer) number of people assigned
assigned_to (object) info about people assigned to the checkin
created_on (string) date of creation of checkin
schedule_on (string) date of next schedule the checkin
is_responded (boolean) if user has responded to the scheduled checkin

Assigned To Object

Attribute Description
id (integer) ID of the employee
emp_type (string) employment type
start_date (string) employee joining date
job_description (string) description of the job
job_title (string) Designation
user employee info details

Create Check-in

POST api/hrm/checkins/questions HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
Sample Request
{
   "question":"Test Check-in ?",
   "assigned_to":[
      145,
      224
   ],
   "schedule_day":"EFR",
   "schedule_time":"ED",
   "is_public":true
}
Sample Response
{
   "id":33,
   "question":"Test Check-in ?",
   "is_active":true,
   "is_public":true,
   "created_by":1,
   "schedule_day":"EFR",
   "schedule_time":"ED",
   "people_count":2,
   "assigned_to":[
      {
         "id":145,
         "emp_type":null,
         "start_date":"2015-09-12",
         "job_description":null,
         "job_title":"Designr1",
         "user":{
            "url":"/users/186",
            "image":"",
            "id":186,
            "full_name":"sachin n",
            "email":"sachin@adhome.com",
            "label_txt":"SN"
         }
      },
      {
         "id":224,
         "emp_type":"FT",
         "start_date":"2016-05-13",
         "job_description":null,
         "job_title":"Developer",
         "user":{
            "url":"/users/274",
            "image":"https://twprofile.s3.amazonaws.com/image.jpg",
            "id":274,
            "full_name":"Ajith Paul",
            "email":"ajith.paul@adhome.com",
            "label_txt":"AP"
         }
      }
   ],
   "created_on":"2016-07-13T07:23:06.225149Z",
   "scheduled_on":null,
   "is_responded":false
}

Returns

If this call succeeds, the checkin object will be returned, else , if the request has got invalid data, it throws an error.

Update Check-in

PUT api/hrm/checkins/questions/{checkin_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
Sample Request
{
   "question":"Test Check-ins ?",
   "assigned_to":[
      45,
      145,
      224
   ],
   "schedule_day":"EFR",
   "schedule_time":"ED",
   "is_public":true
}
Sample Response
{
   "id":33,
   "question":"Test Check-ins ?",
   "is_active":true,
   "is_public":true,
   "created_by":1,
   "schedule_day":"EFR",
   "schedule_time":"ED",
   "people_count":3,
   "assigned_to":[
        {
         "id":45,
         "emp_type":null,
         "start_date":"2015-04-02",
         "job_description":null,
         "job_title":"Admin",
         "user":{
            "url":"/users/17",
            "image":"",
            "id":17,
            "full_name":"Jerrin Tom",
            "email":"jerry@adhome.com",
            "label_txt":"JT"
         }
      },
      {
         "id":145,
         "emp_type":null,
         "start_date":"2015-09-12",
         "job_description":null,
         "job_title":"Designr1",
         "user":{
            "url":"/users/186",
            "image":"",
            "id":186,
            "full_name":"sachin n",
            "email":"sachin@adhome.com",
            "label_txt":"SN"
         }
      },
      {
         "id":224,
         "emp_type":"FT",
         "start_date":"2016-05-13",
         "job_description":null,
         "job_title":"Developer",
         "user":{
            "url":"/users/274",
            "image":"https://twprofile.s3.amazonaws.com/16-image.jpg",
            "id":274,
            "full_name":"Ajith Paul",
            "email":"ajith.paul@adhome.com",
            "label_txt":"AP"
         }
      }
   ],
   "created_on":"2016-07-13T07:23:06.225149Z",
   "scheduled_on":null,
   "is_responded":false
}

Returns

If the call succeeds, it will return the Checkin object. If the call fails, it will throw an error.

Delete Check-in

DELETE api/hrm/checkins/questions/{checkin_id} HTTP/1.1
Accept: application/json
Authorization: Token "YOUR ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json