{"info":{"_postman_id":"cce5ab2a-32cc-45e7-bae2-f3b49fe62e4f","name":"Doo - APIs","description":"

Below is our collection of APIs available for you to access your data in Doo. Access to the API is role based, speak to your HR manager or System Admin to gain access to the API Data Access role.

Data access via this API is ring fenced to your company only.

For any API support queries you can reach out to us on support@doogitaltech.com

Doo - https://doo.software

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"14587961","collectionId":"cce5ab2a-32cc-45e7-bae2-f3b49fe62e4f","publishedId":"2sB3dWqm8V","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"3c8fa5","highlight":"FF6C37"},"publishDate":"2025-12-20T21:31:06.000Z"},"item":[{"name":"Authentication","id":"78f7246d-2473-4cd5-be49-d3eeb2ba547f","protocolProfileBehavior":{"followAuthorizationHeader":false,"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Username\":\"{{username}}\",\n \"Password\":\"{{password}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://doo.software/api/v1/auth/login","description":"

API Access: To gain access to the api, speak to your HR manager / system admin to give you access to the API Data Access role.

\n\n

This endpoint is used to authenticate a user and obtain an access token, the access token must then be used as a Bearer token in subsequent requests.

HTTP Method: POST
Endpoint: https://doo.software/api/v1/auth/login

Request Body

The request body should be in JSON format and must include the following parameters:

Username (string, required): The username of the user.
\n
Password (string, required): The password of the user.
\n

Example request body:

{\n  \"Username\": \"{{username}}\",\n  \"Password\": \"{{password}}\"\n}\n\n

Response

On a successful authentication, the response will return a JSON object with a status code of 200. The response schema is as follows:

{\n  \"$id\": \"string\",\n  \"token\": \"string\"\n}\n\n

Example Response:

{\n  \"Token\": \"string\"\n}\n\n

This token can be used for subsequent authenticated requests.

\n","urlObject":{"protocol":"https","path":["api","v1","auth","login"],"host":["doo","software"],"query":[],"variable":[]}},"response":[{"id":"3678924c-0fdd-4611-bed2-ac58c03e66ad","name":"Authentication: Get Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"username\": \"{{employee@address.com}}\",\r\n \"password\": \"{{doo_password}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://doo.software/api/v1/auth/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"353"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 05 Aug 2024 23:11:53 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":".ASPXAUTH=C8DF9909F7B5C9F5CC6119719C4D381B3D02BD67C7253C41F01497CB900D2750D6611BF354E57729D1ACECC319EAB5E8D5FB662AF9D703F2968B8E8D4C44A5C04F18AD88AA6C5BD0976CEA4B0415989EB33378CE8565340F831AD38EA3DB0D5619996A239B58C7080C4BFFD32B01AE8822D3A3502DD468D7C888BC1B20676049482AE03559906CD047E647956116CFDF45711A5346CC2AC69DA623FEFA79FF73B4899401B1EE21A2D6D52AEE501CCF32; path=/; HttpOnly; SameSite=Lax"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Token\": \"[Bearer_Token]\"\n}"}],"_postman_id":"78f7246d-2473-4cd5-be49-d3eeb2ba547f"},{"name":"Get all Employees","id":"234845d2-6d96-4178-878b-c082175517e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://doo.software/api/v1/employees/getall","description":"

Get All Employees

This endpoint retrieves a list of all employees associated with the authenticated user's CompanyId. It provides detailed information about each employee, which can be useful for managing employee records and understanding workforce demographics.

Request

Method: GET
\n
URL: https://doo.software/api/v1/employees/getall
\n

Response

Status: 200
\n
Content-Type: application/json
\n

The response is a JSON array containing objects that represent employees. Each object includes the following fields:

EmployeeID: Unique identifier for the employee.
\n
Title: The title of the employee (e.g., Mr, Ms).
\n
FirstName: The first name of the employee.
\n
MiddleName: The middle name of the employee (can be null).
\n
LastName: The last name of the employee.
\n
ID_Passport: Identification or passport number.
\n
DOB: Date of birth of the employee.
\n
Gender: Gender of the employee.
\n
EthnicGroup: Ethnic group of the employee.
\n
CriminalCheck: Status of the criminal check (can be null).
\n
Disability: Indicates if the employee has a disability (boolean).
\n
EmployeeNumber: Employee's unique number.
\n
HomeTelephone: Home telephone number (can be null).
\n
Cellphone: Cellphone number of the employee.
\n
EmergencyContactNumber: Emergency contact number.
\n
EmergencyContactPerson: Name of the emergency contact person.
\n
PersonalEmail: Personal email address (can be null).
\n
WorkEmail: Work email address.
\n
TaxNumber: Tax identification number (can be null).
\n
Nationality: Nationality of the employee.
\n
CreatedDate: Date when the employee record was created.
\n
StartDate: Date when the employee started working.
\n
DepartmentName: Name of the department the employee belongs to.
\n
Designation: Job designation of the employee.
\n
ManagerId: Identifier for the employee's manager.
\n
Manager: Name of the employee's manager.
\n
LastUpdated: Timestamp of the last update made to the employee's record.
\n

Example Response Body:

[\n  {\n   \"EmployeeID\": 0,\n   \"Title\": \"\",\n   \"FirstName\": \"\",\n   \"MiddleName\": null,\n   \"LastName\": \"\",\n   \"ID_Passport\": \"\",\n   \"DOB\": \"\",\n   \"Gender\": \"\",\n   \"EthnicGroup\": \"\",\n   \"CriminalCheck\": null,\n   \"Disability\": true,\n   \"EmployeeNumber\": \"\",\n   \"HomeTelephone\": null,\n   \"Cellphone\": \"\",\n   \"EmergencyContactNumber\": \"\",\n   \"EmergencyContactPerson\": \"\",\n   \"PersonalEmail\": null,\n   \"WorkEmail\": \"\",\n   \"TaxNumber\": null,\n   \"Nationality\": \"\",\n   \"CreatedDate\": \"\",\n   \"StartDate\": \"\",\n   \"DepartmentName\": \"\",\n   \"Designation\": \"\",\n   \"ManagerId\": 0,\n   \"Manager\": \"\",\n   \"LastUpdated\": \"\"\n  }\n]\n\n

Note: The response may vary based on the employees available in the authenticated user's company.

\n","urlObject":{"protocol":"https","path":["api","v1","employees","getall"],"host":["doo","software"],"query":[],"variable":[]}},"response":[{"id":"8c455ddc-1023-4f74-8ff0-d14daa59e68e","name":"Get all employees","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"workemail\":\"{{employee_workemail}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://doo.software/api/v1/employees/getall"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"515"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 06 Aug 2024 00:16:09 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"234845d2-6d96-4178-878b-c082175517e1"},{"name":"Get an Employee","id":"c6785c9e-5b7d-4bf3-8a03-9afb264dd708","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://doo.software/api/v1/Employees/getemployee?workemail={{employee@email.com}}","description":"

Get Employee Details

This endpoint retrieves detailed information about a specific employee based on their work email address. It is useful for fetching employee data for management or HR purposes.

Request

Method: GET
\n
URL: https://doo.software/api/v1/Employees/getemployee?workemail={workemail}
\n

Query Parameters:

workemail (string): The work email of the employee whose details are being requested. This parameter is required.

Authentication

This endpoint requires authentication. Ensure that you have valid credentials to access employee data.

Response

Status: 200
\n
Content-Type: application/json
\n

The response is a JSON object containing the following fields:

$id: Identifier for the object (usually for internal tracking).
\n
employeeID: Unique identifier for the employee.
\n
title: The title of the employee (e.g., Mr, Ms).
\n
firstName: The first name of the employee.
\n
middleName: The middle name of the employee (can be null).
\n
lastName: The last name of the employee.
\n
ID_Passport: Identification or passport number.
\n
dob: Date of birth of the employee.
\n
gender: Gender of the employee.
\n
ethnicGroup: Ethnic group of the employee.
\n
criminalCheck: Status of the criminal check (can be null).
\n
disability: Indicates if the employee has a disability (boolean).
\n
employeeNumber: Employee's unique number.
\n
homeTelephone: Home telephone number (can be null).
\n
cellphone: Cellphone number of the employee.
\n
emergencyContactNumber: Emergency contact number.
\n
emergencyContactPerson: Name of the emergency contact person.
\n
personalEmail: Personal email address (can be null).
\n
workEmail: Work email address.
\n
taxNumber: Tax identification number (can be null).
\n
nationality: Nationality of the employee.
\n
createdDate: Date when the employee record was created.
\n
startDate: Date when the employee started working.
\n
departmentName: Name of the department the employee belongs to.
\n
designation: Job designation of the employee.
\n
managerId: Identifier for the employee's manager.
\n
manager: Name of the employee's manager.
\n
lastUpdated: Timestamp of the last update made to the employee's record.
\n

Possible Error Responses

400 Bad Request: If the workemail parameter is missing or invalid.
\n
404 Not Found: If no employee is found with the provided work email.
\n
401 Unauthorized: If authentication fails or is not provided.
\n

Example Response Body:

{\n  \"$id\": \"\",\n  \"employeeID\": 0,\n  \"title\": \"\",\n  \"firstName\": \"\",\n  \"middleName\": null,\n  \"lastName\": \"\",\n  \"iD_Passport\": \"\",\n  \"dob\": \"\",\n  \"gender\": \"\",\n  \"ethnicGroup\": \"\",\n  \"criminalCheck\": null,\n  \"disability\": true,\n  \"employeeNumber\": \"\",\n  \"homeTelephone\": null,\n  \"cellphone\": \"\",\n  \"emergencyContactNumber\": \"\",\n  \"emergencyContactPerson\": \"\",\n  \"personalEmail\": null,\n  \"workEmail\": \"\",\n  \"taxNumber\": null,\n  \"nationality\": \"\",\n  \"createdDate\": \"\",\n  \"startDate\": \"\",\n  \"departmentName\": \"\",\n  \"designation\": \"\",\n  \"managerId\": 0,\n  \"manager\": \"\",\n  \"lastUpdated\": \"\"\n}\n\n

Note: The response may vary based on the employee's details available in the system.

\n","urlObject":{"protocol":"https","path":["api","v1","Employees","getemployee"],"host":["doo","software"],"query":[{"key":"workemail","value":"{{employee@email.com}}"}],"variable":[]}},"response":[{"id":"a85a6bbc-ac39-4d7d-92eb-dd2ce2fb2d95","name":"Get an employee by workemail","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://doo.software/api/v1/employees/getemployee?workemail={{employee@address.com}}","protocol":"https","host":["doo","software"],"path":["api","v1","employees","getemployee"],"query":[{"key":"workemail","value":"{{employee@address.com}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"515"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 06 Aug 2024 00:16:09 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c6785c9e-5b7d-4bf3-8a03-9afb264dd708"},{"name":"Get all Designations","id":"e62d948e-3908-4c20-97c0-c98f284ccb39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://doo.software/api/v1/designations/getdesignation?designationid={{designationid}}","description":"

Get Designation

This endpoint retrieves the designation details for a specific designation ID. It is useful for obtaining information about a particular designation within the system.

Request

Method: GET
\n
URL: https://doo.software/api/v1/designations/getdesignation?designationid={designationId}
\n
Query Parameters:
\n
- designationid (integer, required): The unique identifier for the designation you want to retrieve.
\n

Response

Status: 200
\n
Content-Type: application/json
\n

The response is a JSON object containing the details of the requested designation. The structure of the response includes the following fields:

designationId: The unique identifier of the designation.
\n
designation: The name or title of the designation.
\n
description: A brief description of the designation (can be an empty string).
\n
createdDate: The date when the designation was created (can be an empty string).
\n
active: A boolean indicating whether the designation is currently active.
\n
objectives: An object containing additional details about the designation's objectives, which includes:
\n
- $id: Identifier for the objectives (can be an empty string).
  \n
- $values: An array of values related to the objectives (can be empty).
  \n
\n

Example Response Body:

{\n  \"$id\": \"\",\n  \"designationId\": 0,\n  \"designation1\": \"\",\n  \"description\": \"\",\n  \"createdDate\": \"\",\n  \"active\": true,\n  \"objectives\": {\n    \"$id\": \"\",\n    \"$values\": [{\n       \"title\": \"\",\n       \"objective\": \"\",\n       \"priority\": \"\"\n     }]\n  }\n}\n\n

Note: The response may vary based on the designation ID provided in the request.

\n","urlObject":{"protocol":"https","path":["api","v1","designations","getdesignation"],"host":["doo","software"],"query":[{"key":"designationid","value":"{{designationid}}"}],"variable":[]}},"response":[{"id":"10d254fb-5db7-4a25-b399-3eb9ddb69aa3","name":"Get a designation","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6WyJsZW5lc2hAZG9vZ2l0YWx0ZWNoLmNvbSIsImxlbmVzaEBkb29naXRhbHRlY2guY29tIl0sIkNvbXBhbnlJZCI6IjE0IiwibmJmIjoxNzIyNTI4MDIwLCJleHAiOjE3MjI1MjgzMTksImlhdCI6MTcyMjUyODAyMH0.ezroIaac8ljig5cDM96oW-_VLs31tjQ6QMe7T_livBA","type":"text","disabled":true}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://doo.software/api/v1/designations/getdesignation?designationid={{designationid}}","protocol":"https","host":["doo","software"],"path":["api","v1","designations","getdesignation"],"query":[{"key":"designationid","value":"{{designationid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"515"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 06 Aug 2024 00:16:09 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"e62d948e-3908-4c20-97c0-c98f284ccb39"},{"name":"Get a Designation","id":"67a1ab05-a3fb-4c5c-b68f-d574b1c81c4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://doo.software/api/v1/designations/GetAll","description":"

Get All Designations

This endpoint retrieves a list of all designations available for the user's company.

Request

Method: GET
\n
URL: https://doo.software/api/v1/designations/GetAll
\n

Response

Status: 200
\n
Content-Type: application/json
\n

The response is a JSON array containing objects that represent designations. Each object includes the following fields:

designationId: Unique identifier for the designation.
\n
designation: Name of the designation.
\n
description: Description of the designation (can be null).
\n
createdDate: Date when the designation was created.
\n
active: Indicates if the designation is active (boolean).
\n
objectives: An object containing objectives related to the designation, which may include an array of values.
\n

Example Response Body:

{\n  \"$id\": \"\",\n  \"$values\": [\n    {\n      \"$id\": \"\",\n      \"designationId\": 0,\n      \"designation1\": \"\",\n      \"description\": \"\",\n      \"createdDate\": \"\",\n      \"active\": true,\n      \"objectives\": {\n        \"$id\": \"\",\n        \"$values\": [{\n            \"title\": \"\",\n            \"objective\": \"\",\n            \"priority\": \"\"\n         }]\n      }\n    }\n  ]\n}\n\n

Note: The response structure may vary based on the designations available in the system.

\n","urlObject":{"protocol":"https","path":["api","v1","designations","GetAll"],"host":["doo","software"],"query":[],"variable":[]}},"response":[{"id":"fa2d0028-1073-4afd-8283-7cee82babdf9","name":"Get all designations","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6WyJsZW5lc2hAZG9vZ2l0YWx0ZWNoLmNvbSIsImxlbmVzaEBkb29naXRhbHRlY2guY29tIl0sIkNvbXBhbnlJZCI6IjE0IiwibmJmIjoxNzIyNTI4MDIwLCJleHAiOjE3MjI1MjgzMTksImlhdCI6MTcyMjUyODAyMH0.ezroIaac8ljig5cDM96oW-_VLs31tjQ6QMe7T_livBA","type":"text","disabled":true}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://doo.software/api/v1/designations/getall"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"515"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 06 Aug 2024 00:16:09 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"67a1ab05-a3fb-4c5c-b68f-d574b1c81c4b"},{"name":"Get all Public Holidays","id":"414b277c-0f3e-4025-8fdd-f2db661eb7fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://doo.software/api/v1/publicholidays/getall","description":"

Get All Public Holidays

This endpoint retrieves a list of all public holidays available in the system.

Request

Method: GET
\n
URL: https://doo.software/api/v1/publicholidays/getall
\n

Response

Status Code: 200 OK
\n
Content-Type: application/json
\n

The response will contain a JSON object structured as follows:

{\n  \"$id\": \"\",\n  \"$values\": [\n    {\n      \"$id\": \"\",\n      \"country\": \"\",\n      \"holiday\": \"\",\n      \"description\": \"\",\n      \"date\": \"\"\n    }\n  ]\n}\n\n

Response Structure

$id: A unique identifier for the response object.
\n
$values: An array containing holiday objects.
\n
- Each holiday object includes:
  \n
  - $id: A unique identifier for the holiday.
    \n
  - country: The country where the holiday is observed.
    \n
  - holiday: The name of the holiday.
    \n
  - description: A brief description of the holiday.
    \n
  - date: The date on which the holiday occurs.
    \n
  \n
\n

This endpoint does not require any input parameters and returns a comprehensive list of public holidays, which can be used for various applications, such as holiday scheduling or planning.

\n","urlObject":{"protocol":"https","path":["api","v1","publicholidays","getall"],"host":["doo","software"],"query":[],"variable":[]}},"response":[{"id":"1e00e5c7-25a3-4cfd-a5f4-2fa2540d7452","name":"Get all Public Holidays","originalRequest":{"method":"GET","header":[],"url":"https://doo.software/api/v1/publicholidays/getall"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"414b277c-0f3e-4025-8fdd-f2db661eb7fd"}],"auth":{"type":"bearer","bearer":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"id":"20cd6c3b-c53a-402f-9f56-22c913b5fed0","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"32a5c011-9f58-494e-8eb6-160f2f12ee21","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}]}

API Access: To gain access to the api, speak to your HR manager / system admin to give you access to the API Data Access role.

Login Authentication

Request Body

Response

Get All Employees

Request

Response

Example Response Body:

Get Employee Details

Request

Authentication

Response

Possible Error Responses

Example Response Body:

Get Designation

Request

Response

Example Response Body:

Get All Designations

Request

Response

Example Response Body:

Get All Public Holidays

Request

Response

Response Structure