API Documentation

Introduction

Welcome to the Desklog API documentation! Desklog is a powerful time tracking and project time tracking software designed to help businesses monitor productivity and manage team performance.

Our public API currently focuses on key functionalities, including:

  • Viewing and editing user details.
  • Managing teams and their configurations.
  • Accessing detailed reports, such as attendance and activity logs.

This documentation provides all the necessary information about endpoints, request formats, authentication, and examples to help you efficiently integrate Desklog's features into your systems. Start exploring the Desklog API and streamline your workflow!


Authentication

To use the Desklog API, all requests must be authenticated to ensure secure and authorized access. Desklog uses Bearer Token authentication, which requires including your API token in the request header.

You can find your API integration setup and generate your API token by navigating to: Desklog → Settings → Integration → Desklog Api Integration

Make sure to keep your token secure, as it provides access to your Desklog data. Include this token in the header of every API request to successfully interact with the API.

Authentication Header Format:
Bash
1 Authorization: Bearer {your_api_token}

API's

The API folder contains all the endpoints available for interacting with the Desklog platform. Each endpoint is designed to perform specific operations, such as retrieving, updating, or managing data related to user details, teams, and reports.

Base URL:

All API requests should be sent to the following base URL:

https://app.desklog.io/api/v2/

This folder serves as the central hub for accessing Desklog's public API capabilities, ensuring seamless integration with your applications. Use these endpoints to view and edit user details, manage teams, and retrieve detailed reports like attendance logs.


Ping

The "ping" section in the Desklog API allows users to verify the connectivity and availability of the API server. By sending a request to this endpoint, users can quickly check if the server is responsive and operational, helping them troubleshoot any potential issues with their integration.

Responses

Response Attributes

status boolean


time number

Current UTC timestamp


message string

GET/api/v2/ping
1 curl --location 'https://app.desklog.io/api/v2/ping'

Response
                       
{
    "status": true,
    "time": 12346789,
    "message": "Ping success"
}


User List

The user_list section allows users to retrieve a list of all users within the system. This functionality enables users to easily view and manage user data, such as user IDs, names, and contact information. By accessing this section, users can efficiently maintain and update their user database.

Header parameters

Authorization string

A header parameter containing the authorization token for accessing the user list API endpoint.

Body parameters

status string

user status - active or archived

Enum values: active archive


role array

admin, manager, team_leader or user


tracking_type string

Enum values: app web

Responses

Response Attributes

status boolean


message string


data array


id number


name string


email string


active boolean

Archive status of user.


phone string


team_id number

id of team which the user is part of.


team_name string

Name of team which the user is part of.


user_type string

user type of user - admin. manager, team_leader or user


role string

defined role for user


time_zone string

timezone of user


app_and_os string

App version and Os details of user.

POST/api/v2/user_list
curl --location --request GET 'https://app.desklog.io/api/v2/user_list' \
--header 'Authorization: {{AUTH_TOKEN}}' \
--header 'Content-Type: application/json' \
--data '{
  "status": "active",
  "role": {},
  "tracking_type": "app"
}'

Response
{
  "status": true,
  "message": "success",
  "data": [
    {
      "id": 1,
      "name": "John Doe",
      "email": "john@doe.com",
      "active": true,
      "phone": "123456789",
      "team_id": 1,
      "team_name": "Team 1",
      "user_type": "admin",
      "role": "System Admin",
      "time_zone": "UTC",
      "app_and_os": "desklog_2.21_Windows_11"
    }
  ]
  }

User Profile

The user profile section allows users to retrieve detailed information about a specific user within the Desklog system. By accessing this section, users can view profile information such as user details, preferences, and settings. This section provides a centralized location for user-specific data, simplifying the process of retrieving and updating user information.

Header parameters

Authorization string

This header parameter is used to authenticate the user and authorize access to the user_profile endpoint.

Body parameters

email string Required

This body parameter is used to provide the email address of the user for fetching their profile information.

Responses

Response Attributes

status boolean


message string


data object


id string


name string


email string


active boolean

Archive status of user.


phone string


team_id number

id of team which the user is part of.


team_name string

Name of team which the user is part of.


user_type string

user type of user - admin. manager, team_leader or user


role string

defined role for user


time_zone string

timezone of user


app_and_os string

App version and Os details of user.

POST/api/v2/user_profile
curl --location --request GET 'https://app.desklog.io/api/v2/user_profile' \
--header 'Authorization: {{AUTH_TOKEN}}' \
--data-raw '{
"email": "john@doe.com"
}'

Response
{
"status": true,
"message": "success",
"data": {
  "id": "1",
  "name": "John Doe",
  "email": "john@doe.com",
  "active": true,
  "phone": "123456789",
  "team_id": 1,
  "team_name": "Team 1",
  "user_type": "admin",
  "role": "System Admin",
  "time_zone": "UTC",
  "app_and_os": "desklog_2.21_Windows_11"
}
}

User Profile Update

The user profile update section allows users to update their profile information in Desklog seamlessly. Users can modify their email, name, and phone number to ensure accurate and up-to-date personal details within the platform. This functionality enables users to keep their profiles current and relevant for effective communication and record-keeping.

Header parameters

Authorization string

The authorization token for accessing the API.

Body parameters

email string Required

The email address associated with the user's profile.


new_name string

The new name to be updated for the user's profile.


new_phone number

The new phone number to be updated for the user's profile.

Responses

Response Attributes

status boolean


message string


data object

POST/api/v2/user_profile_update
curl --location 'https://app.desklog.io/api/v2/user_profile_update' \
  --header 'Authorization: {{AUTH_TOKEN}}' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "email": "john@doe.com",
    "new_name": "john doe",
    "new_phone": 123123123
  }'

Response
{
    "status": true,
    "message": "User profile successfully updated",
    "data": {}
  }

User Register

The "user register" section allows users to create a new user within the Desklog platform. By providing the necessary information, users can easily register and gain access to all features and functionalities offered by Desklog. This API section simplifies the user registration process, enabling seamless onboarding for new users.

Header parameters

Authorization string

This header parameter is used to authenticate the user during the user registration process. It is required for access to the POST /api/v2/user_register endpoint.

Body parameters

user_role number Required

Role id of user - Can be obtained from /user_roles api


email string Required


tracking_selected string Required

preferred tracking type of user

Enum values: app Web


team number

id of team which the user should be placed under.


tracking_type string


employee_id number


punching_id number


jira_account_id string


clickup_id number

Responses

Response Attributes

status boolean


message string


data string

POST/api/v2/user_register
                        curl --location 'https://app.desklog.io/api/v2/user_register' \
--header 'Authorization: {{AUTH_TOKEN}}' \
--data-raw '{
  "user_role": 1,
  "email": "john@doe.com",
  "tracking_selected": "app",
  "team": 1,
  "employee_id": null,
  "punching_id": null,
  "jira_account_id": null,
  "clickup_id": null
}'

Response
{
    "status": true,
    "message": "User added successfully",
    "data": null
  }

Team List

The team list section allows users to retrieve a list of teams within their organization, providing valuable insights into the structure and composition of their workforce. With this information, users can effectively manage team assignments and streamline communication and collaboration within their organization.

Header parameters

Authorization string

Specifies the authentication token needed to access the API endpoint. This parameter is required for every request to the team_list endpoint.

Responses

Response Attributes

status boolean


message string


data array


team_id number

id of team


team_name string

name of team


lead_by number

user id of user who leads the team


added_by boolean

user id of user who created the team

POST/api/v2/user_register
curl --location 'https://app.desklog.io/api/v2/team_list' \ --header 'Authorization: {{AUTH_TOKEN}}' \

Response
{
    "status": true,
    "message": "Success",
    "data": [
      {
        "team_id": 1,
        "team_name": "RD-1",
        "lead_by": 9,
        "added_by": 1
      }
    ]
  }

Team Details

The team details section allows users to retrieve detailed information about a specific team. By using this API, users can access essential data related to a team, such as member details. This functionality enables seamless collaboration and efficient management within the team.

Header parameters

Authorization string

A header parameter used to authenticate the request and verify the identity of the user making the API call.

Body parameters

team_id number Required

Responses

Response Attributes

status boolean


message string


data object


id number

id of team


team_name string

name of team


lead_by number

user id of user who leads the team


added_by number

user id of user who created the team


members array


user_id number

user id of user


email string

email of user

POST/api/v2/team_show
                        curl --location 'https://app.desklog.io/api/v2/team_show' \
--header 'Authorization: {{AUTH_TOKEN}}' \
--data '{
"team_id": 1
}'

Response
{
  "status": true,
  "message": "Success",
  "data": {
    "id": 1,
    "team_name": "Team 1",
    "lead_by": 1,
    "added_by": 1,
    "members": [
      {
        "user_id": 91,
        "email": "john@doe.com"
      }
    ]
  }
}

Team Create

The team create section allows users to create a new team within the Desklog platform. By providing essential information such as team name, lead, and team members, users can establish a cohesive group for collaboration and project management. This API endpoint streamlines the process of setting up teams, facilitating efficient communication and workflow organization within the system.

Header parameters

Authorization string

The API key used to authenticate the request.

Body parameters

team_name string Required

The name of the team that is being created.


team_member array Required

The user ID of a team member to be added to the team.


lead_by number

The user ID of the team leader who will be creating the team.


Responses

Response Attributes

status boolean


message string


data string

POST/api/v2/team_create
curl --location 'https://app.desklog.io/api/v2/team_create' \
--header 'Authorization: {{AUTH_TOKEN}}' \
--data '{
"team_name": "Team 1",
"team_member": [
  1,
  2
],
"lead_by": 1
}'

Response
{
  "status": true,
  "message": "New team created successfully.",
  "data": null
}

Team Delete

The team delete section allows users to remove a team from Desklog, effectively deleting all associated data and members. By utilizing this API endpoint, users can effectively manage their teams and maintain accurate records within the Desklog platform.

Header parameters

Authorization string

The Authorization header parameter is used to authenticate the request and must contain a valid token for the API to process the team deletion.

Body parameters

team_id number Required

The team_id body parameter specifies the unique identifier of the team that is to be deleted from the system.

Responses

Response Attributes

status boolean


message string


data string

POST/api/v2/team_show
curl --location 'https://app.desklog.io/api/v2/team_delete' \
--header 'Authorization: {{AUTH_TOKEN}}' \
--data '{
"team_id": 1
}'

Response
{
"status": true,
"message": "Team has been deleted successfully!",
"data": null
}

Rename Team

The "rename_team" section allows users to update the name of a specific team within the Desklog platform. By using this API feature, users can easily customize the team name to better reflect their organization's structure or branding. This functionality enhances the overall user experience and ensures that team information remains up-to-date and relevant.

Header parameters

Authorization string

The Authorization header parameter contains the authentication token required to access the rename_team endpoint.

Body parameters

team_id number Required

The team_id body parameter specifies the unique identifier of the team that is to be renamed.


team_name string Required

The team_name body parameter represents the new name that will be assigned to the team identified by team_id.

Responses

Response Attributes

status boolean


message string


data string

POST/api/v2/rename_team
curl --location 'https://app.desklog.io/api/v2/rename_team' \
--header 'Authorization: {{AUTH_TOKEN}}' \
--data '{
"team_id": 1,
"team_name": "Team Name"
}'

Response
{
"status": true,
"message": "Team Name Changed",
"data": null
}

Add Team Member

The "add team member" section allows users to seamlessly add new members to their team within the Desklog system. By utilizing this functionality, users can easily expand their team and streamline collaboration with new members. This API section simplifies the process of onboarding new team members, enhancing efficiency and productivity within the organization.

Header parameters

Authorization string

A header parameter that contains the authentication token for the request.

Body parameters

team_id number Required

A body parameter that specifies the ID of the team to which the new member will be added.


new_member array Required

A body parameter that provides the details of the new member being added to the team.

Responses

Response Attributes

status boolean


message string


data string

POST/api/v2/add_team_member

Response
{
"status": true,
"message": "Team Name Changed",
"data": null
}

Remove Team Member

The "remove team member" section allows users to efficiently manage their team by removing a specific member from a designated team. By utilizing this functionality, users can streamline team organization and access control within their project or organization. This section facilitates the smooth handling of team member changes and permissions.

Header parameters

Authorization string

The Authorization header parameter is used to authenticate the request and verify the identity of the user making the API call

Body parameters

team_id number Required

The team_id body parameter specifies the unique identifier of the team from which the member will be removed.


member_id number Required

The member_id body parameter specifies the unique identifier of the team member to be removed from the specified team.

Responses

Response Attributes

status boolean


message string


data string

POST/api/v2/remove_team_member

Response
{
"status": true,
"message": "Team Name Changed",
"data": null
}

Attendance Report

The "attendance report" section in the Desklog API allows users to generate detailed reports of employee attendance within a specified date range. With this feature, users can track and analyze attendance data to gain insights into workforce patterns and trends. This section provides valuable information for monitoring employee attendance and improving overall productivity.

Header parameters

Authorization string

A security token to authorize access to the attendance report API endpoint.

Body parameters

from_date string Required

Specifies the start date for the attendance report to be generated.


to_date string Required

Specifies the end date for the attendance report to be generated.


user_id integer

user id of user. If given, report will be showed for the particular user.

Responses

Response Attributes

status boolean


message string


data array


team_id number

user id of user.


employee_id string

employee id of user.


name string

name of user.


email string

email of user.


team_name string

name of team which user is part of.


clock_in string

Clock in time of user. (If given a date range, average will be provided).


clock_out string

Clock out time of user. (If given a date range, average will be provided).


time_at_work string

Total worked time of user.


productive_time string

Total productive time of user.


focus_time string

Total focus time of user.


idle_time string

Total idle time of user.


private_time string

Total private time of user.


neutral_time string

Total neutral time of user.


non_productive_time string

Total non productive time of user.


over_time string

Total over time of user.


minimum_working_hours string

Minimum working hours of user.


activity_percentage number

Activity percentage of user.


efficiency_percentage string

Efficiency percentage of user.


task_assigned_time string

Total task assigned time of user.


task_spent_time string

Total task spent time of user.


isWorkWithIdle number

Whether time at work includes idle time or not


time_zone string

Time zone of user


client_app_details string

App version and Os details details of user

POST/api/v2/attendance_report

Response
{
"status": true,
"message": "Success",
"data": [
{
  "user_id": 1,
  "employee_id": "1",
  "name": "John Doe",
  "email": "john@doe.com",
  "team_name": "Team 1",
  "clock_in": "11:31 AM",
  "clock_out": "01:56 PM",
  "time_at_work": "02h 30m",
  "productive_time": "02h 15m",
  "focus_time": "02h 30m",
  "idle_time": "--",
  "private_time": "--",
  "neutral_time": "00h 15m",
  "non_productive_time": "--",
  "over_time": "--",
  "minimum_working_hours": "08h 00m",
  "activity_percentage": 80,
  "efficiency_percentage": "--",
  "task_assigned_time": "08h 00m",
  "task_spent_time": "10h 28m",
  "isWorkWithIdle": 1,
  "time_zone": "Asia/Kolkata",
  "client_app_details": "desklog_2.21_Windows_11"
}
]
}

Project List

The "project_list" section in the desklog API allows users to retrieve a list of projects and their associated tasks within the system. By accessing this section, users can efficiently view and manage project details, track progress, and organize tasks effectively within their workspace. This section provides a clear overview of all ongoing projects and their respective tasks, streamlining project management processes for users.

Header parameters

Authorization string

The Authorization header parameter contains the authentication credentials required to access the project_list endpoint. It is used to verify the identity of the client making the request.

Query parameters

limit string

The limit parameter specifies the maximum number of projects to return in the response. If not provided, the default limit is applied.


offset string

The offset parameter is used to specify the starting point from which projects should be retrieved in the response. It determines the index of the first project to be returned.


Responses

Response Attributes

status boolean


message string


data array


id number


project_name string


access number

1 = Private (restricted access), 0 = Public (open access)


integrated_from string


project_status string


project_priority string

GET/api/v2/project/?limit=&offset=

Response

{
"status": true,
"message": "success",
"data": [
    {
    "id": 98,
    "project_name": "erf4t",
    "access": 1,
    "integrated_from": "desklog",
    "project_status": "Ongoing",
    "project_priority": "Intermediate"
    },
    {
    "id": 97,
    "project_name": "set2",
    "access": 1,
    "integrated_from": "desklog",
    "project_status": "Ongoing",
    "project_priority": "Low"
    }
]
}

                    

Project Details

The "project_details" section allows users to retrieve detailed information about a specific project, including its tasks, deadlines, and progress status. With this section, users can easily access and review project details to stay organized and informed about their work.

Header parameters

Authorization string

A header parameter that allows the client to authenticate and access the specified project information. It should contain the necessary credentials required for authorization.


Responses

Response Attributes

status boolean


message string


data object


id number


project_name string


access number

1 = Private (restricted access), 0 = Public (open access)


integrated_from string


project_status string


project_priority string


board_members array


1 number


5 number


project_working_hour number


estimated_amount string

GET/api/v2/project/117

Response

{
    "status": true,
    "message": "success",
    "data": {
        "id": 115,
        "project_name": "test public1",
        "access": null,
        "integrated_from": "desklog",
        "project_status": "Ongoing",
        "project_priority": "Intermediate",
        "board_members": [
        1,
        5
        ],
        "project_working_hour": 42,
        "estimated_amount": "650.00"
    }
    }
  
                      

Project Create

The project_create section allows users to create new project entries within the desklog system. By utilizing this functionality, users can efficiently establish and track project details such as project name, access levels, priority, client association, end date, estimated hours, and estimated amount. This API section streamlines the process of project creation and management, enhancing overall project organization and tracking capabilities.

Header parameters

Authorization string

The authorization token required for accessing the API and making requests. Ensures secure communication and authenticates the user.

Body Parameters

project_name string

The name of the project, providing a brief and clear identifier for the project. Should be unique and descriptive.


access number

The level of access granted for the project, specifying who can view, edit, or manage the project details. Can have values like read-only, write, or admin access. 1 = Private (restricted access), 0 = Public (open access)


priority number

The priority of the project, indicating its importance relative to other projects. Values can range from low to high. 1 > critical, 2 > intermediate, 3 > low,4 > trivial


client_id number

The unique identifier of the client associated with the project. Helps in linking the project with the client's information and interactions.


end_date string

The end date of the project, specifying when the project is expected to be completed. Should be in a valid date format.


project_estimated_hours number

The estimated number of hours required to complete the project. This helps in planning resource allocation and project timelines.


project_estimated_amount number

The estimated cost or budget allocated for the project. This helps in financial planning and tracking project expenses.


Responses

Response Attributes

status boolean


message string


data string

GET/api/v2/project

Response

{
    "status": true,
    "message": "Project created successfully",
    "data": {
        "project_id": 125
    }
}
  
                      

Project Delete

The project_delete section allows users to remove a specific project from the system. By utilizing this API, users can effectively manage their project lists and streamline their workflow by deleting unnecessary or completed projects. This section empowers users to maintain a clean and organized project environment within the desklog platform.

Header parameters

Authorization string

The Authorization header parameter is used to authenticate the client's request to delete the project with ID 117. It typically contains the API key or token required to authorize the operation.


Responses

Response Attributes

status boolean


message string


data string

GET/api/v2/project

Response

{
    "status": true,
    "message": "Project deleted successfully",
    "data": null
    }
  
                      

Project Priority

Header Parameters

Authorization string

Query Parameters

limit string


offset string

GET/api/v2/priority?limit=10&offset=0

Task List

The task_list section allows users to retrieve a list of tasks associated with a project in the desklog platform. Users can view and manage project tasks efficiently through this API section, facilitating improved project management and task tracking.

Header parameters

Authorization string

The Authorization header parameter is used for authentication and authorization purposes. It typically contains a bearer token or API key to validate the user's identity and permissions.

Query Parameters

limit string

The limit parameter is used to specify the maximum number of tasks to be returned in the response. It helps in pagination and controlling the number of results displayed.


offset string

The offset parameter is used to specify the starting point from which tasks should be retrieved. It helps in fetching results beyond the first set of tasks and is useful for pagination.


Responses

Response Attributes

status boolean


message string


data array


id number


task_title string


basic_status_id number


current_status string

GET/api/v2/task?limit=3&offset=1

Response

{
    "status": true,
    "message": "success",
    "data": [
        {
        "id": 648,
        "task_title": "test task anu - 10-4-25",
        "basic_status_id": 2,
        "current_status": "In Progress"
        },
        {
        "id": 647,
        "task_title": "test task amal - 10-4-25",
        "basic_status_id": 2,
        "current_status": "In Progress"
        },
        {
        "id": 646,
        "task_title": "test task Aishu Dilna - 10-4-25",
        "basic_status_id": 4,
        "current_status": "Completed"
        }
    ]
    }
  
                      

Task Details

The task_show section allows users to retrieve detailed information about a specific task within the desklog project management system. By accessing this API endpoint, users can view key details such as task title, description, due date, priority, and assigned team members. This section provides a comprehensive view of individual tasks, aiding users in effectively managing their project workflow.

Header parameters

Authorization string

The Authorization header parameter is used to authenticate the request to access the task_show endpoint. It must contain a valid authentication token to authorize the user's access to the specific task.


Responses

Response Attributes

status boolean


message string


data object


task_title string


description string


project_id number


assigned_to number


reporter_id number


task_type_id number


priority_id number


priority string


current_status string


time_spend_in_sec number


time_allocated_sec number


time_allocated_pretty string


task_exceeded boolean


is_billable number

GET/api/v2/task/628

Response

{
"status": true,
"message": "success",
"data": {
    "task_title": "task hee",
    "description": "

decfef

", "project_id": 115, "assigned_to": 1, "reporter_id": 1, "task_type_id": 4, "priority_id": 2, "priority": "Intermediate", "current_status": "Fixed", "time_spend_in_sec": 86186, "time_allocated_sec": 600, "time_allocated_pretty": "00h 10m", "task_exceeded": true, "is_billable": 1 } }

Task Create

The task_create section allows users to create a new task within the desklog project management system. With this API, users can easily add tasks, assign them to team members, set deadlines, and specify project details. This section streamlines the process of task creation, enhancing project organization and collaboration.

Header parameters

Authorization string

The authentication token used to verify the user's identity and permissions.

Body parameters

task_title string

The title or name of the task to be created.


assignee number

The user or team member assigned to the task for completion.


assigned_time number

The timestamp when the task was assigned to the assignee.


task_type number

The type or category of the task to classify its nature or purpose. normal >> 1, bug >> 4


is_billable number

Indicates whether the task is billable, used for tracking billable hours or services. 0 => non billable, 1 => billable


description string

A detailed description or information about the task to provide context and guidance.


priority_id number

The priority level assigned to the task, indicating its importance or urgency.


start_date string

The start date of the task, indicating when work on the task is scheduled to begin.


end_date string

The end date of the task, specifying when the task is expected to be completed.


project_id number

The unique identifier for the project to which the task belongs.


Responses

Response Attributes

status boolean


message string


data string

PATCH/api/v2/task

Response

{
    "status": true,
    "message": "Task added successfully, but the assigned time has been set to zero as it exceeds the project's allocated time.",
    "data": {
        "task_id": 125
    }
}
          
                              

Task Delete

The task_delete section allows users to remove a specific task from a project within the desklog API. By utilizing this section, users can efficiently manage their project tasks and maintain an organized workflow by deleting unnecessary or completed tasks as needed.

Header parameters

Authorization string

This header parameter is used to authenticate the request and provide authorization to access the DELETE endpoint for deleting a task with the specified ID.


Responses

Response Attributes

status boolean


message string


data string

DELETE/api/v2/task/633

Response

{
    "status": true,
    "message": "Task deleted successfully",
    "data": null
    }
              
                                  

Task Update

The task_update section allows users to update specific details of a task within the desklog project management system. With this API, users can effortlessly modify task attributes such as status, due date, priority, and assignee information. Enhance your project management workflow by seamlessly managing and updating individual tasks with ease.

Header parameters

Authorization string

The Authorization header parameter is used to authenticate the API request.

Body Parameters

task_title string


priority string


assigned_to number


assigned_time number


description string


start_date string


end_date string


is_billable number


task_type number


Responses

Response Attributes

status boolean


message string

PATCH/api/v2/task/632

Response

{
    "status": true,
    "message": "Task updated successfully."
    }
  
                      

Task Status Change

The task_status_change section allows users to update the status of a specific task within the desklog project management system. By utilizing this API functionality, users can easily manage and track the progress of individual tasks, improving overall project efficiency and organization.

Header parameters

Authorization string

The Authorization header parameter is used to authenticate the API request. It typically contains the access token or API key required to access the endpoint securely.

Body Parameters

task_id number

The task_id parameter uniquely identifies the task for which the status change is requested. This parameter is required for the task_status_change endpoint.


status string

The status parameter specifies the new status to be assigned to the task. This parameter is required for the task_status_change endpoint. status => start,pause,stop


Responses

Response Attributes

basic_status number


message string


data object


id number


tag string

GET/api/v2/task_tag?limit=20&offset=0

Response

{
"status": true,
"message": "success.",
"data": [
{
"id": 7,
"tag": "black"
},
{
"id": 103,
"tag": "dflkgtdrseawsedrftgi"
},
{
"id": 101,
"tag": "esde"
},
{
"id": 102,
"tag": "new tag"
}
]
}
  
                      

Task Priority

Header Parameters

Authorization string

Query Parameters

limit string


offset string

GET/api/v2/priority?limit=10&offset=0

Tag List

The list_task_tag section allows users to retrieve a list of task tags associated with projects and tasks. By accessing this section, users can easily categorize and organize their tasks based on different tags, helping them streamline and prioritize their project management efforts effectively.

Header parameters

Authorization string

Contains the authentication credentials required to access the API endpoint securely.

Query Parameters

limit string

Specifies the maximum number of task tags to return in the response. Default value is 10.


offset string

Specifies the number of task tags to skip before starting to return them in the response. Default value is 0.


Responses

Response Attributes

basic_status number


self_task number


message string

POST/api/v2/task_status_change

Response

{
    "basic_status": 2,
    "self_task": null,
    "message": "Task Status Updated"
    }
                  
                                      

Tag Add

The "add_task_tag" section in the desklog API allows users to assign tags to tasks within a project. By using this feature, users can organize and categorize tasks more effectively, enabling better tracking and management of project activities. This functionality enhances task management capabilities and streamlines project workflow for improved productivity.

Header parameters

Authorization string

The Authorization header parameter contains the access token used for authentication to authorize the API request.

Body Parameters

name string

The name parameter specifies the name of the task tag to be added


Responses

Response Attributes

status number


message string

POST/api/v2/task_tag

Response

{
    "status": false,
    "message": "Entered tag already exist"
	"data": {
          "tag_id": 142
     }
}
  
                      

Tag Edit

The edit_task_tag section allows users to modify the tags associated with a specific task within the desklog project management system. By utilizing this functionality, users can update and customize task tags to improve organization and workflow efficiency within their projects. This section empowers users to tailor task tags to suit their specific project needs and enhance overall task management capabilities.

Header parameters

Authorization string

The Authorization header parameter is used to authenticate the request to perform the editing of the task tag with ID 103.

Body Parameters

name string

The name parameter specifies the new name to be assigned to the task tag with the ID 103.


Responses

Response Attributes

status boolean


message string

PATCH/api/v2/task_tag/103

Response

{
    "status": true,
    "message": "Tag name edited successfully."
    }
      
                          

Tag Delete

The delete_task_tag section allows users to remove a specific tag associated with a task within the desklog project management system. By utilizing this API functionality, users can efficiently manage and organize task tags, streamlining their workflow and improving project organization.

Header parameters

Authorization string

A header parameter used for authentication and authorization purposes. It contains the access token or API key required to access the specified endpoint.


Responses

Response Attributes

status boolean


message string

DELETE/api/v2/task_tag/104

Response

{
    "status": true,
    "message": "Tag deleted successfully."
    }
          
                              

Client List

The client_list section allows users to retrieve a list of clients associated with their projects and tasks within the desklog platform. This API section provides users with the ability to access and manage client information, facilitating efficient organization and tracking of project stakeholders. By utilizing this section, users can easily view and interact with client data to streamline project management processes.

Header parameters

Authorization string

A security token that authorizes the request to access client information.

Query parameters

limit string

Specifies the maximum number of clients to return in the response.


offset string

Indicates the starting point within the list of clients to retrieve data from.


Responses

Response Attributes

status boolean


message string


data object


id number


first_name string


email string

GET/api/v2/client?limit=10&offset=0

Response

{
    "status": true,
    "message": "success",
    "data": [
        {
        "id": 1,
        "first_name": "Adil",
        "email": "adil_cli@gmail.com"
        },
        {
        "id": 3,
        "first_name": "Pranav Govindq",
        "email": "pranav_cli@gmail.com"
        },
        {
        "id": 4,
        "first_name": "Ajay P",
        "email": "ajay_cli@gmail.com"
        }
    ]
    }
              
                                  

Client Add

The "add_client" section allows users to create a new client within the desklog project management system. By using this API, users can easily add and manage client information for their projects, streamlining the workflow and organization of project tasks.

Header parameters

Authorization string

The authorization token required to authenticate and authorize the client API request.

Body parameters

name string


email string


address string


city string


state string


post_code string


country string


phone string


Responses

Response Attributes

status boolean


message string


data string

GET/api/v2/client

Response

{
    "status": true,
    "message": "Client added successfully",
    "data": {
        "client_id": 132
    }
}
                  
                                      

Client Update

The "update_client" section allows users to modify and update client information within the desklog project and tasks API. With this functionality, users can seamlessly update client details to ensure accurate and up-to-date project management.

Header parameters

Authorization string

The access token that authorizes the client to make changes to the specified client data.

Body parameters

name string


email string


address string


city string


state string


post_code string


country string


phone string


Responses

Response Attributes

status boolean


message string


data string

PATCH/api/v2/client/22

Response

{
    "status": true,
    "message": "Client details updated successfully",
    "data": null
    }
  
                      

Client Delete

The delete_client section allows users to remove a client from the desklog project, freeing up resources and maintaining a clean database. By utilizing this feature, users can efficiently manage their client list and ensure accurate project tracking and reporting.

Header parameters

Authorization string

The Authorization header parameter is used to authenticate the client in order to access and delete the client information. It contains the access token or credentials required to authorize the client request.


Responses

Response Attributes

status boolean


message string

DELETE/api/v2/client/25

Response

{
    "status": true,
    "message": "Client deleted"
    }