Many of the features that make Profit.co OKRs so successful are available through the API. This API lets you read and write data programmatically so that you can integrate data from various sources leveraging the power of Profit.co.
\nEvery Profit.co API request must be authenticated with your API key and access key. Include both keys in each request you send.
\nYou may send the same credentials using these headers instead:
\nPlease, refer to the answer post to get your Profit.co account's API key and access key
https://www.profit.co/answers/general/settings-preferences/where-can-i-find-my-api-key-and-access-key/
Base URL (use the one for your data region):
app.profit.co
eu2-app.profit.co
me1-app.profit.co
sa1-app.profit.co
Required: API key of your Profit.co Account
\n"},{"key":"accessKey","value":"Required: Access key of your Profit.co Account
\n"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"data","value":"{\"parentDepartmentId\":2285025,\"parentDepartmentName\":\"Engineering\",\"parentIconCls\": \"star\",\"customAttributes\":[],\"hrbp\":[],\"grades\":[],\"modifiedGradeIds\":[],\"iconCls\":\"history\",\"deptHeadName\":\"\",\"cc\":\"#2196F3\",\"isAssignAsObjToggle\":false,\"totalWt\":\"0.00\",\"departmentName\":\"Mobile\",\"deptHeadObjRefId\":null,\"reviewCriterias\":[],\"authorizedEmployees\":[],\"isEnabled\":\"Y\"}\n","description":"Required: department details to be created
\n"},{"key":"subDepartmentIds","value":"[]"}]},"url":"https:// + baseUrl + /app/dao/v5/appsettings?a=createDepartment","description":"To create a new department in your Profit.co account
\n","urlObject":{"protocol":"https","path":["app","dao","v5","appsettings"],"host":[" + baseUrl + "],"query":[{"description":{"content":"action type
\n","type":"text/plain"},"key":"a","value":"createDepartment"}],"variable":[]}},"response":[{"id":"2bd79d1f-5549-45f6-bdf8-f2e4f78c7398","name":"Create Department","originalRequest":{"method":"POST","header":[{"key":"apiKey","value":"Required: API key of your Profit.co Account
\n"},{"key":"accessKey","value":"Required: Access key of your Profit.co Account
\n"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"data","value":"{\"departmentId\":2289870,\"departmentName\":\"Mobile1\",\"isEnabled\":\"Y\",\"parentDepartmentId\":2285025,\"cc\":\"#5758BB\",\"iconCls\":\"pt-jira\",\"reviewCriterias\":[],\"authorizedEmployees\":[],\"rg\":[],\"hrbp\":[],\"grds\":[],\"dl\":\"Department\",\"aopkc\":\"Y\",\"firmId\":600018,\"customAttributes\":[],\"createdBy\":2112439,\"lastUpdatedBy\":2112439,\"createdByName\":\"developer mobile\",\"creationDate\":\"2022-10-12 07:48:41\",\"lastUpdateDate\":\"2022-10-12 07:48:41\",\"lastUpdatedByName\":\"developer mobile\",\"version\":1,\"objectId\":49,\"name\":\"Mobile1\",\"employeeIds\":[],\"parentIconCls\":\"star\",\"childrens\":[{\"departmentId\":2289871,\"departmentName\":\"test mobile\",\"isEnabled\":\"Y\",\"parentDepartmentId\":2289870,\"parentDepartmentName\":\"Mobile\",\"cc\":\"#4b6584\",\"iconCls\":\"donut_large\",\"reviewCriterias\":[],\"authorizedEmployees\":[],\"hrbp\":[],\"dl\":\"Department\",\"aopkc\":\"Y\",\"firmId\":600018,\"customAttributes\":[],\"createdBy\":2112439,\"lastUpdatedBy\":2112439,\"createdByName\":\"developer mobile\",\"creationDate\":\"2022-10-12 08:00:17\",\"lastUpdateDate\":\"2022-10-12 08:00:17\",\"lastUpdatedByName\":\"developer mobile\",\"version\":0,\"objectId\":49,\"name\":\"test mobile\",\"employeeIds\":[],\"parentIconCls\":\"star\"}],\"includeLoginEnabledUsers\":true,\"isAssignAsObjToggle\":false,\"totalWt\":\"0.00\",\"showDefaultOwner\":true,\"parentDepartmentName\":\"Engineering\"}","description":"Required: department details to be updated
\n"},{"key":"subDepartmentIds","value":"[SUB_DEPARTMENT_ID1,SUB_DEPARTMENT_ID2]","description":"Array of Sub department Id
\n"}]},"url":"https:// + baseUrl + /app/dao/v5/appsettings?a=updateDepartment","description":"To update the department in your profit.co account
\n","urlObject":{"protocol":"https","path":["app","dao","v5","appsettings"],"host":[" + baseUrl + "],"query":[{"description":{"content":"action type
\n","type":"text/plain"},"key":"a","value":"updateDepartment"}],"variable":[]}},"response":[{"id":"3546352b-bbb7-42de-bbf9-8ae524aa7535","name":"Update Department","originalRequest":{"method":"POST","header":[{"key":"apiKey","value":"Required: API key of your Profit.co Account
\n"},{"key":"accessKey","value":"Required: Access key of your Profit.co Account
\n"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"departmentId","value":"Required: Department Id
\n"}]},"url":"https:// + baseUrl + /app/dao/v6/okrsettings?a=deleteDepartment","description":"To delete the department by DepartmentId
\n","urlObject":{"protocol":"https","path":["app","dao","v6","okrsettings"],"host":[" + baseUrl + "],"query":[{"description":{"content":"action type
\n","type":"text/plain"},"key":"a","value":"deleteDepartment"}],"variable":[]}},"response":[{"id":"604fe049-fd2b-4ca2-ae94-30c1a2961a4c","name":"Delete Department","originalRequest":{"method":"POST","header":[{"key":"apiKey","value":"Required: API key of your Profit.co Account
\n"},{"key":"accessKey","value":"Required: Access key of your Profit.co Account
\n"}],"url":"https:// + baseUrl + /app/dao/v6/departments?a=getAll","description":"To get all the departments of your Profit.co account.
\n","urlObject":{"protocol":"https","path":["app","dao","v6","departments"],"host":[" + baseUrl + "],"query":[{"key":"a","value":"getAll"}],"variable":[]}},"response":[{"id":"e9217ad1-3889-4e6c-b093-e1624cdcd6e2","name":"Get All Departments API","originalRequest":{"method":"GET","header":[{"key":"apiKey","value":"Required: API key of your Profit.co Account
\n"},{"key":"accessKey","value":"Required: Access key of your Profit.co Account
\n"}],"url":"https:// + baseUrl + /app/dao/v6/employees?a=getAllEmployeesByFilterSearch&numRecords=To get the users list by the filter
\n","urlObject":{"protocol":"https","path":["app","dao","v6","employees"],"host":[" + baseUrl + "],"query":[{"key":"a","value":"getAllEmployeesByFilterSearch"},{"description":{"content":"Integer, number of results to be returned. Max permissible value: 5000
\n","type":"text/plain"},"key":"numRecords","value":"Y - It will give the enabled users list\nN - It will give the disabled users list
\n","type":"text/plain"},"key":"ls","value":"[\"Y\"]"},{"key":"filterData","value":"{\"managerIds\":[],\"departmentIds\":[XXXXX],\"jobTitleIds\":[]}"},{"key":"sortColumn","value":"employeeNumber.sortable"},{"key":"sortDir","value":"asc"}],"variable":[]}},"response":[{"id":"dafc7b19-b489-4549-84d9-08936447c279","name":"Get Users List by the Department","originalRequest":{"method":"GET","header":[{"key":"apiKey","value":"APIs to manage the departments of your Profit.co account, such as retrieving the list of departments and their details.
\n","_postman_id":"8e556b19-4b68-49da-a6a8-abbd967996ed"},{"name":"Employees","item":[{"name":"Create Employee","id":"720761c2-9afe-4ea9-9b08-7adcaf164161","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"apiKey","value":"Required: API key of your Profit.co Account
\n"},{"key":"accessKey","value":"Required: Access key of your Profit.co Account
\n"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"employeeData","value":"{\"employeeNumber\":\"Auto Generated Number\",\"loginEnabled\":\"Y\",\"customAttributes\":[],\"managerName\":\"Profit APITest\",\"hrbp\":[],\"mmrs\":[],\"taCurrencyCode\":\"USD\",\"pfau\":\"N\",\"firstName\":\"API\",\"lastName\":\"Testing2\",\"emailId\":\"profitapitesting2@berijam.com\",\"managerId\":2115252,\"srid\":null,\"assigneeDetails\":[],\"departmentName\":\"Engineering\",\"departmentId\":2265538,\"jobTitleName\":\"Software Engineer\",\"jobTitleId\":13,\"okrScoreId\":5,\"okrScoreName\":\"Individual Contributors\",\"fullName\":\"API Testing2\",\"labels\":[],\"tags\":[],\"roles\":[{\"roleId\":\"HlzSgXsBWQ5Na8qaAekT\",\"name\":\"PROFIT_USER\",\"description\":\"Has access to create, view, update, delete objectives and key results\",\"roleName\":\"Profit User\",\"editable\":\"Y\",\"firmId\":260069,\"rolePrivileges\":[{\"privilegeId\":\"8836\",\"version\":0},{\"privilegeId\":\"8835\",\"version\":0},{\"privilegeId\":\"8834\",\"version\":0}],\"version\":0,\"isChecked\":true}],\"impersonators\":[]}","description":"Required: user details to be created
\n"}]},"url":"https:// + baseUrl + /app/dao/v6/employees?a=save","description":"Creates a new employee in your Profit.co account. Send the employee details as JSON in the employeeData field of a URL-encoded body.
\nMain fields in employeeData:
\nfirstName, lastName, emailId: required
loginEnabled: Y to let the employee log in
managerId: the manager’s employee ID
departmentId, jobTitleId: department and job title
roles: the roles to give the employee
Response: the created employee, including the new employeeId.
\n","urlObject":{"protocol":"https","path":["app","dao","v6","employees"],"host":[" + baseUrl + "],"query":[{"description":{"content":"action type
\n","type":"text/plain"},"key":"a","value":"save"}],"variable":[]}},"response":[{"id":"2c18cc88-a294-4853-b8e3-a42beaac5001","name":"Create Employee","originalRequest":{"method":"POST","header":[{"key":"apiKey","value":"Required: API key of your Profit.co Account
\n"},{"key":"accessKey","value":"Required: Access key of your Profit.co Account
\n"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"updateEmployeeData","value":"{\"objectStatus\":\"0\",\"employeeNumber\":\"2\",\"firstName\":\"API\",\"lastName\":\"Testing1\",\"fullName\":\"API Testing1\",\"employeeId\":2115956,\"effectiveStartDate\":\"11/01/2021\",\"managerName\":\"Profit APITest\",\"managerId\":2115252,\"loginEnabled\":\"Y\",\"enabled\":\"Y\",\"workShiftId\":2035938,\"workShiftName\":\"Standard\",\"personStatus\":\"Employee\",\"status\":\"Active\",\"emailId\":\"profitapitesting1@berijam.com\",\"userId\":2094833,\"pfau\":\"N\",\"okrScoreId\":5,\"impersonators\":[],\"firmId\":260069,\"phoneNumbers\":[],\"createdBy\":2094137,\"lastUpdatedBy\":2094137,\"createdByName\":\"Profit APITest\",\"creationDate\":\"Nov 01, 2021 07:41:44 AM\",\"lastUpdateDate\":\"Nov 01, 2021 07:41:44 AM\",\"lastUpdatedByName\":\"Profit APITest\",\"version\":0,\"sortNumber\":\"000000000000000000000000000000000000000000000000000000000002\",\"uniqueColor\":\"#ff7675\",\"nameAsIcon\":\"AT\",\"objectId\":8,\"objectRefId\":2115956,\"objectRefName\":\"API Testing1\",\"roles\":[{\"roleId\":\"HlzSgXsBWQ5Na8qaAekT\",\"name\":\"PROFIT_USER\",\"description\":\"Has access to create, view, update, delete objectives and key results\",\"roleName\":\"Profit User\",\"editable\":\"Y\",\"firmId\":260069,\"rolePrivileges\":[{\"privilegeId\":\"8836\",\"version\":0},{\"privilegeId\":\"8835\",\"version\":0},{\"privilegeId\":\"8834\",\"version\":0}],\"version\":2}],\"title\":\"\",\"hrbp\":[],\"mmrs\":[],\"customAttributes\":[],\"taCurrencyCode\":\"USD\",\"departmentName\":\"Engineering\",\"departmentId\":2265538,\"jobTitleId\":null,\"jobTitleName\":null,\"okrScoreName\":\"Individual Contributors\",\"labels\":[],\"tags\":[]}","description":"Required: user details to be updated
\n"},{"key":"attributeName","value":"[\"departmentName\"]","description":"Required: Edited attribute names
\n","disabled":true},{"key":"isPartialUpdate","value":"Y","description":"Use Y to update only the fields you send. Use N for a full update.
\n","disabled":true}]},"url":"https:// + baseUrl + /app/dao/v6/employees?a=update","description":"Updates the details of an existing employee. Send the data as JSON in the updateEmployeeData field of a URL-encoded body.
\nPartial update: set isPartialUpdate to Y and send only the fields you want to change. You can use attributeName to limit the update to certain fields. All other details stay unchanged.
Full update: if isPartialUpdate is N or omitted, send the full employee data.
This API doesn’t change roles; use the role APIs for that.
\nExample (isPartialUpdate=Y):
{\"employeeId\":2115956,\"departmentId\":2265538,\"departmentName\":\"Engineering\"}
Response: the updated employee.
\n","urlObject":{"protocol":"https","path":["app","dao","v6","employees"],"host":[" + baseUrl + "],"query":[{"description":{"content":"action type
\n","type":"text/plain"},"key":"a","value":"update"}],"variable":[]}},"response":[{"id":"16576ee8-da4e-444b-8c83-875f66eb687f","name":"Update Employee","originalRequest":{"method":"POST","header":[{"key":"apiKey","value":"Required: API key of your Profit.co Account
\n"},{"key":"accessKey","value":"Required: Access key of your Profit.co Account
\n"}],"url":"https:// + baseUrl + /app/dao/v6/employees?a=endEmployment&employeeId=Ends the employment of an employee. The employee is marked as terminated (objectStatus = 1) and can no longer log in. The record is kept, and Get All Employees returns it when objectStatus=1.
\nParameters:
\nemployeeId: ID of the employee to terminate (required)
endDate: last working date, in your account’s date format, for example MM/dd/yyyy (optional)
Response:
\nstatus: SUCCESS with the employee’s details: the employee was terminated.
status: FAILURE: the employee ID was not found.
action type
\n","type":"text/plain"},"key":"a","value":"endEmployment"},{"description":{"content":"Required : Employee Id
\n","type":"text/plain"},"key":"employeeId","value":"Last working date of the employee (MM/dd/yyyy).
\n","type":"text/plain"},"key":"endDate","value":"MM/dd/yyyy"}],"variable":[]}},"response":[{"id":"e002efad-0908-4655-9506-06a358f836df","name":"Terminate Employee","originalRequest":{"method":"POST","header":[{"key":"apiKey","value":"Required: API key of your Profit.co Account
\n"},{"key":"accessKey","value":"Required: Access key of your Profit.co Account
\n"}],"url":"https:// + baseUrl + /app/dao/v6/employees?a=getAll","description":"Gets the employees in your Profit.co account, one page at a time.
\nParameters:
\nnumRecords: number of employees to return. Default 50, maximum 100.
startIndex: position of the first employee. Starts at 0, so 0 is the first employee. startIndex + numRecords must not exceed 10,000.
sortColumn: field to sort by, for example employeeNumber. Default: first name.
sortDir: asc (default) or desc.
objectStatus: set to 1 to get terminated employees. If set to 0 or omitted, active employees are returned (the default).
filterData: filter by login status. Use {\"ls\":[\"Y\"]} for login-enabled employees or {\"ls\":[\"N\"]} for login-disabled employees.
includeRoleGrants: use N to leave out the roleGrants section from the response. Default: Y.
Response:
\ndata: the list of employees on this page.
countOfRecords: total number of employees that match.
roleGrants: role assignments, each with roleId, firmId, userId, startDate and version. Left out when includeRoleGrants=N.
licensedUserCount: number of active users per role.
status: SUCCESS or FAILURE. A request over the record limit returns FAILURE.
Required: Integer, number of results to be returned. Max permissible value: 100
\n","type":"text/plain"},"key":"numRecords","value":"Use [\"Y\"] for login-enabled employees or [\"N\"] for login-disabled employees.
\n","type":"text/plain"},"key":"filterData","value":"{\"ls\":[\"Y\"]}"},{"disabled":true,"description":{"content":"Use N to leave out the roleGrants section from the response
\n","type":"text/plain"},"key":"includeRoleGrants","value":"N"},{"disabled":true,"description":{"content":"Set to 1 to get terminated employees. If set to 0 or omitted, active employees are returned (the default).
Required: API key of your Profit.co Account
\n"},{"key":"accessKey","value":"Required: Access key of your Profit.co Account
\n"}],"url":"https:// + baseUrl + /app/dao/v6/datamanagement?a=getAll&objectId=603","description":"Gets employees’ login and logout history, including the date, time and IP address of each login. Only admin (super user) accounts can use this API.
\nParameters:
\nobjectId: always 603 (required)
startDate: returns records from this date onward, in yyyy-MM-dd HH:mm:ss format, in the API user’s time zone (required)
numResults: number of records to return. Default and maximum: 100.
Paging: take the creationDate of the last record in data and use it as the next startDate. Stop when countOfRecords is less than numResults.
\nResponse: countOfRecords and data, the list of login records.
\n","urlObject":{"protocol":"https","path":["app","dao","v6","datamanagement"],"host":[" + baseUrl + "],"query":[{"key":"a","value":"getAll"},{"key":"objectId","value":"603"},{"disabled":true,"description":{"content":"Integer, number of results to be returned. Max permissible value: 5000
\n","type":"text/plain"},"key":"numResults","value":"Required: Date from which the audit logs to be returned. Must be in the yyyy-MM-dd HH:mm:ss format in the PST timezone.
\n","type":"text/plain"},"key":"startDate","value":"Required: API key of your Profit.co Account
\n"},{"key":"accessKey","value":"Required: Access key of your Profit.co Account
\n"}],"url":"https:// + baseUrl + /app/dao/v6/employees?a=getById&employeeId=Gets the details of a single employee by employee ID.
\nParameters:
\nemployeeId: ID of the employee (required)
\nResponse: the employee’s details.
\n","urlObject":{"protocol":"https","path":["app","dao","v6","employees"],"host":[" + baseUrl + "],"query":[{"key":"a","value":"getById"},{"description":{"content":"Required: ID of the employee whose details you want to get
\n","type":"text/plain"},"key":"employeeId","value":"APIs to manage the employees in your Profit.co account: list employees, get an employee’s details, create, update, and terminate employees, and view login history.
\nAuthentication: Send your keys in the request headers X-Profit-Api-Key and X-Profit-Access-Key (or apiKey and accessKey). Don’t put keys in the URL.
\nRequest body: Send POST requests as URL-encoded (application/x-www-form-urlencoded), not form-data.
\nResponse: Every response includes status (SUCCESS or FAILURE). Missing or invalid keys return HTTP 401.
\n","_postman_id":"00e56709-8305-401b-9d4e-09539dbe49eb"},{"name":"Goals","item":[{"name":"get All My Goals / My Orgs' Goals","id":"8f36d27a-56d8-4fd4-b96c-c6b28296419f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.profit.co/app/goals?a=getAll&startDate=MM/dd/yyyy&endDate=MM/dd/yyyy&yearStartDate=MM/dd/yyyy&yearEndDate=MM/dd/yyyy&ownerId=action type
\n","type":"text/plain"},"key":"a","value":"getAll"},{"description":{"content":"Required: Quarter or target start date
\n","type":"text/plain"},"key":"startDate","value":"MM/dd/yyyy"},{"description":{"content":"Required: Quarter or target end date
\n","type":"text/plain"},"key":"endDate","value":"MM/dd/yyyy"},{"description":{"content":"Required: Target start date
\n","type":"text/plain"},"key":"yearStartDate","value":"MM/dd/yyyy"},{"description":{"content":"Required: Target start date
\n","type":"text/plain"},"key":"yearEndDate","value":"MM/dd/yyyy"},{"description":{"content":"Required: Unique Id
\n","type":"text/plain"},"key":"ownerId","value":"Required: Page Identifier
\n","type":"text/plain"},"key":"tab","value":"MY_GOALS/MY_ORG_GOALS"},{"key":"filterData","value":"{\"customAttributes\":[],\"priorityCodes\":[]}"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"Required: Goal details to be created
\n","type":"text"},{"key":"tab","value":"MY_GOALS","description":"Required: Page Identifier
\n","type":"text"}]},"url":"https://api.profit.co/app/goals?a=save&apiKey=action type
\n","type":"text/plain"},"key":"a","value":"save"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"Required: Unique Id for goal.
\n","type":"text"}]},"url":"https://api.profit.co/app/goals?a=getById&apiKey=action type
\n","type":"text/plain"},"key":"a","value":"getById"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"Required: Goal details to be updated.
\n","type":"text"},{"key":"tab","value":"MY_GOALS","description":"Required: Page Identifier
\n","type":"text"},{"key":"modifiedFields","value":"[\"pn\",\"pc\",\"krs\"]","description":"Required: Fileds to be modified.
\n","type":"text"}]},"url":"https://api.profit.co/app/goals?a=update&apiKey=action type
\n","type":"text/plain"},"key":"a","value":"update"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"Required: Unique code for status
\n","type":"text"},{"key":"sn","value":"Required: Unique Name for status
\n","type":"text"},{"key":"progress","value":"Required: Progress value for goal to be change
\n","type":"text"},{"key":"comment","value":"Test Comment","description":"Optional: Description
\n","type":"text"},{"key":"goalId","value":"Required: Unique Id for goal.
\n","type":"text"}]},"url":"https://api.profit.co/app/goals?a=updateGoalProgress&apiKey=action type
\n","type":"text/plain"},"key":"a","value":"updateGoalProgress"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"Required: Unique Id for goal.
\n","type":"text"},{"key":"tab","value":"MY_GOALS","description":"Required: Page Identifier
\n","type":"text"}]},"url":"https://api.profit.co/app/goals?a=delete&apiKey=action type
\n","type":"text/plain"},"key":"a","value":"delete"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"action type
\n","type":"text/plain"},"key":"a","value":"gsgls"},{"description":{"content":"Required: Quarter or target end date
\n","type":"text/plain"},"key":"startDate","value":"MM/dd/yyyy"},{"description":{"content":"Required: Quarter or target end date
\n","type":"text/plain"},"key":"endDate","value":"MM/dd/yyyy"},{"description":{"content":"Required: Target start date
\n","type":"text/plain"},"key":"yearStartDate","value":"MM/dd/yyyy"},{"description":{"content":"Required: Target start date
\n","type":"text/plain"},"key":"yearEndDate","value":"MM/dd/yyyy"},{"description":{"content":"Required: Unique Id
\n","type":"text/plain"},"key":"ownerId","value":"Required: Page Identifier
\n","type":"text/plain"},"key":"tab","value":"MY_ORG_GOALS"},{"key":"filterData","value":"{\"customAttributes\":[],\"priorityCodes\":[]}"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"To get the job titles list
\nThis API will return the all configuration details, in the response need to take jobTitlesList key values.
\n","urlObject":{"protocol":"https","path":["app","dao","v6","objective"],"host":["api","profit","co"],"query":[{"key":"a","value":"getConfigData"},{"description":{"content":"Required
\n","type":"text/plain"},"key":"objectId","value":"560"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"Required and unique value :jobTitleName & jobFunctionCode,
Required: monthlyQuota (value should be greater than 0)
To create a new job title in your Profit.co account
\n","urlObject":{"protocol":"https","path":["app","dao","v5","appsettings"],"host":["api","profit","co"],"query":[{"key":"a","value":"createJobTitle"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"Required: Job Title details to be updated
\n","type":"text"},{"key":"isMonthlyQuotaChanged","value":"true","type":"text","description":"If Monthly Quota value changed then need to send this key with value as true otherwise we can skip this key
\n"}]},"url":"https://api.profit.co/app/dao/v5/appsettings?a=updateJobTitle&apiKey=To update the job title in your profit.co account
\n","urlObject":{"protocol":"https","path":["app","dao","v5","appsettings"],"host":["api","profit","co"],"query":[{"key":"a","value":"updateJobTitle"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"APIs to manage the job titles of your Profit.co account, such as retrieving the list of available job titles and their details.
\n","_postman_id":"91cdf10e-7271-4175-8fa7-7054b8fa3c42"},{"name":"News Feed & Audit","item":[{"name":"Get Audit Logs","id":"a07dcfde-391b-40e3-9b2f-33061678504f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.profit.co/app/dao/v6/datamanagement?a=getAll&objectId=191&numResults=Read the audit log which includes the transaction history like record create, update, delete.
\nThis method will return the audit logs from the \"startDate\" specified. Get the creationDate of the last record from \"data\" and call the API again by setting the startDate to creationDate to get the next set of records. API will return empty \"data\" indicating that no records exists after the specified startDate. Stop calling the API when results.countOfRecords < numResults.
\nHere is the details of Profit.co audit logs.
\nInteger, number of results to be returned. Max permissible value: 5000
\n","type":"text/plain"},"key":"numResults","value":"Required: Date from which the audit logs to be returned. Must in the yyyy-MM-dd HH:mm:ss format in the PST timezone.
\n","type":"text/plain"},"key":"startDate","value":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"This API will give the recent changes of OKRs, Tasks, etc.
\nThis API will return the details in \"walls\" response.
\n\"walls\" key having \"wallEntries\" list.
\n\"wallEntries\" have the below details,
\nRequired: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"{\n \"noteText\": \"COMMENT\",\n \"objectId\": <6 - Tasks, 563 - Key Results>,\n \"objectRefId\": TASK_ID or KEY_RESULT_ID,\n \"associations\": [\n {\n \"objectId\": <6 - Tasks, 563 - Key Results>,\n \"objectName\": \"TASK or KEYRESULT\",\n \"objectRefId\": \n }\n ],\n \"objectName\": \"TASK or KEYRESULT\"\n \"parentObjectId\": 7,\n \"isSendEmail\": \"N\"\n}
\n","urlObject":{"protocol":"https","path":["app","dao","note"],"host":["api","profit","co"],"query":[{"key":"a","value":"createNote"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"If you want to read the \"Task\" comments, you have to pass the value as 6 (Integer)\nIf you want to read the \"Key Result\" comments, you have to pass the value as 563 (Integer)
\n","type":"text/plain"},"key":"selectedObjectId","value":"6 - Tasks, 563 - Key Results"},{"description":{"content":"Array of Task ID or Key Result ID
\n","type":"text/plain"},"key":"selectedObjectRefIds","value":"[ID1, ID2]"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"To get all the OKRs (Individual, department, team and corporate OKRs) of your Profit.co account.
\nOWNER_TYPE_ID - 8 or 49 or 91 or 1.
It is an integer field and the value can be 8 for Individual Level (Employee) OKRs, 49 for department level OKRs, 91 for team level OKRs and 1 for Corporate (Company) level OKRs.
OWNER_ID - employee id (You can get this from get all employees API), department id (You can get this from get all departments API), team id (You can get this from get all teams API) or firm id.
\n","urlObject":{"protocol":"https","path":["app","dao","v6","objective"],"host":["api","profit","co"],"query":[{"description":{"content":"action type
\n","type":"text/plain"},"key":"a","value":"getAll"},{"key":"startIndex","value":"0"},{"description":{"content":"Required: Integer, number of results to be returned. Max permissible value: 50
\n","type":"text/plain"},"key":"numRecords","value":"Required: It is an integer field and the value can be 8 for Individual Level (Employee) OKRs, 49 for department level OKRs, 91 for team level OKRs and 1 for Corporate (Company) level OKRs.
\n","type":"text/plain"},"key":"ownerTypeId","value":"Required: It can be employee id, department id, team id or firm id (You have to pass this value based on the owner type id and you can refer the Get departments, teams and employees APIs)
\n","type":"text/plain"},"key":"ownerId","value":"Required: Quarter or target start date
\n","type":"text/plain"},"key":"startDate","value":"MM/dd/yyyy"},{"description":{"content":"Required: Quarter or target end date
\n","type":"text/plain"},"key":"endDate","value":"MM/dd/yyyy"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"To get the heatmap data of departmente by passing the departmentIds as param.
\n","urlObject":{"protocol":"https","path":["app","dao","v6","objective"],"host":["api","profit","co"],"query":[{"key":"a","value":"getHeatMapData"},{"description":{"content":"Department ids with comma separated. For Example, [1001, 1002, 1003]. You can get these ids from \"Get All Departments API\"
\n","type":"text/plain"},"key":"departmentIds","value":"[departmentId]"},{"description":{"content":"Quarter or target start date
\n","type":"text/plain"},"key":"startDate","value":"MM/dd/yyyy"},{"description":{"content":"Quarter or target end date
\n","type":"text/plain"},"key":"endDate","value":"MM/dd/yyyy"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"To get the current quarter OKRs of the individual users by the user email id.
\n","urlObject":{"protocol":"https","path":["app","dao","v6","objective"],"host":["api","profit","co"],"query":[{"description":{"content":"action type
\n","type":"text/plain"},"key":"a","value":"getIndividualOkrsByEmailId"},{"description":{"content":"Required: Email id of the Profit.co user
\n","type":"text/plain"},"key":"emailId","value":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"To get the objective and its key results by objective id.
\n","urlObject":{"protocol":"https","path":["app","dao","v6","objective"],"host":["api","profit","co"],"query":[{"description":{"content":"action type
\n","type":"text/plain"},"key":"a","value":"getById"},{"description":{"content":"Required: Unique Id of the OKR
\n","type":"text/plain"},"key":"objectiveId","value":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"To get the key result and its objectives by key result id.
\n","urlObject":{"protocol":"https","path":["app","dao","v6","keyresult"],"host":["api","profit","co"],"query":[{"description":{"content":"action type
\n","type":"text/plain"},"key":"a","value":"getById"},{"description":{"content":"Required: Unique Id of the KR
\n","type":"text/plain"},"key":"keyResultId","value":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"To get the recent check-in history of the key result by key result id.
\n","urlObject":{"protocol":"https","path":["app","dao","v6","keyresult"],"host":["api","profit","co"],"query":[{"description":{"content":"action type
\n","type":"text/plain"},"key":"a","value":"getAllRecentHistory"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"Required: Unique Id of the KR
\n","type":"text/plain"},"key":"keyResultId","value":"This API works for your Increase KPI, Decrease KPI and Percentage Tracked type of key results.
\n[{\"id\":5,\"statusCode\":\"NOT_STARTED\",\"statusName\":\"Not Started\"},{\"id\":1,\"statusCode\":\"ON_TRACK\",\"statusName\":\"On Track\"},{\"id\":3,\"statusCode\":\"AT_RISK\",\"statusName\":\"At Risk\"},{\"id\":2,\"statusCode\":\"IN_TROUBLE\",\"statusName\":\"In Trouble\"},{\"id\":4,\"statusCode\":\"COMPLETED\",\"statusName\":\"Completed\"},{\"id\":6,\"statusCode\":\"ARCHIVED\",\"statusName\":\"Archived\"}]
\nThe planned check-in date of your KR. The date format depends on your location or country. \nFor Example, US - [MM/dd/yyyy: 12/25/2020] India -[dd/MM/yyyy: 25/12/2020]
\n","urlObject":{"protocol":"https","path":["app","dao","v6","keyresult"],"host":["api","profit","co"],"query":[{"description":{"content":"action type
\n","type":"text/plain"},"key":"a","value":"addStatus"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"Required: Unique Id of the KR
\n","type":"text/plain"},"key":"keyResultId","value":"Required: Unique Id of the OKR
\n","type":"text/plain"},"key":"objectiveId","value":"Required: Progress value of your KR. This will be applicable for incerase KPI, decrease KPI and percentage tracked type of key results.
\n","type":"text/plain"},"key":"value","value":"Required: Status of your KR
\n","type":"text/plain"},"key":"statusName","value":"Required: Status Id Reference:
\n","type":"text/plain"},"key":"statusId","value":"Optional: your check-in comment.
\n","type":"text/plain"},"key":"comment","value":"Required: The planned check-in date of your KR.
\n","type":"text/plain"},"key":"actualUpdateDate","value":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"customer satisfaction
\",\"bottomUpAligedOkrs\":[],\"delegateOkrs\":[],\"delegationTypeName\":null,\"delegationTypeId\":null,\"kwe\":\"N\",\"objectiveStatusName\":\"Not Started\",\"objectiveStatusId\":5}\n","description":"Required: Objective details to be created
\n","type":"text"},{"key":"objectiveIds","value":"[Optional: It is an aligned objective Ids, alignment only available for all employees visibility.
\n","type":"text"},{"key":"ownerId","value":"Required: It can be employee id, department id, team id or firm id (You have to pass this value based on the owner type id and you can refer the Get departments, teams and employees APIs)
\n","type":"text"},{"key":"ownerTypeId","value":"Required: It is an integer field and the value can be 8 for Individual Level (Employee) OKRs, 49 for department level OKRs, 91 for team level OKRs and 1 for Corporate (Company) level OKRs.
\n","type":"text"}]},"url":"https://api.profit.co/app/dao/v6/objective?a=save&apiKey=action type
\n","type":"text/plain"},"key":"a","value":"save"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"Optional: It is an aligned objective Ids, alignment only available for all employees visibility.
\n","type":"text"},{"key":"sharedObjectiveIds","value":"[]","type":"text"},{"key":"modifiedFields","value":"[\"objectiveName\",\"description\"]","type":"text"},{"key":"addedOkrs","value":"[]","type":"text"},{"key":"removedOkrs","value":"[]","type":"text"},{"key":"ownerTypeId","value":"Required: It is an integer field and the value can be 8 for Individual Level (Employee) OKRs, 49 for department level OKRs, 91 for team level OKRs and 1 for Corporate (Company) level OKRs.
\n","type":"text"},{"key":"ownerId","value":"Required: It can be employee id, department id, team id or firm id (You have to pass this value based on the owner type id and you can refer the Get departments, teams and employees APIs)
\n","type":"text"},{"key":"objectiveId","value":"Required: Unique Id of the OKR
\n","type":"text"},{"key":"isAddAsKr","value":"\"Y\"","type":"text"},{"key":"syncChanges","value":"\"Y\"","type":"text"},{"key":"objectiveData","value":"{\"objectiveId\":2118729,\"objectiveName\":\"Research and improve customer satisfaction. - Update\",\"objectiveStatusId\":5,\"objectiveStatusName\":\"Not Started\",\"periodId\":9,\"periodName\":\"Q3-2021\",\"progress\":0,\"keyResults\":[],\"isWatched\":false,\"watchers\":[],\"sharedOkrs\":[],\"delegationOkrs\":[],\"visibilities\":[{\"visibilityId\":1,\"visibilityName\":\"All Employees\"}],\"delegateOkrs\":[],\"objectStatus\":\"0\",\"ownerTypeId\":8,\"ownerId\":2115252,\"createdEmployeeId\":2115252,\"orderedBy\":390,\"alignedWithMeOkrs\":[],\"alignedWithOthersOkrs\":[],\"targetStartDate\":\"07/01/2021\",\"targetEndDate\":\"09/30/2021\",\"confidencePercentage\":0,\"periodType\":\"QUARTER\",\"isTr\":\"Y\",\"isPr\":\"Y\",\"kwe\":\"N\",\"ato\":[{\"objectId\":8,\"objectname\":\"Employee\",\"objectRefId\":2115252,\"objectRefName\":\"Profit APITest\"}],\"pp\":65.934,\"firmId\":260069,\"lc\":\"en\",\"createdBy\":2094137,\"lastUpdatedBy\":2094137,\"createdByName\":\"Profit APITest\",\"creationDate\":\"2021-08-30 01:59:05\",\"lastUpdateDate\":\"2021-08-30 04:13:20\",\"lastUpdatedByName\":\"Profit APITest\",\"version\":3,\"selectedItems\":[1],\"selectedPeriodMonth\":\"Q3-2021\",\"objOwner\":[],\"shareOkrs\":[],\"sharedEmployees\":[],\"okrLevel\":{\"code\":\"INDIVIDUAL_OKRS\",\"ownerId\":2115252,\"ownerTypeId\":8,\"name\":\"My Individual OKRs\"},\"description\":\"customer satisfaction.
\",\"delegationTypeName\":null,\"delegationTypeId\":null}","description":"Required: Objective details to be updated.
\n","type":"text"},{"key":"taggedObjectRefIds","value":"[]","type":"text"}]},"url":"https://api.profit.co/app/dao/v6/objective?a=update&apiKey=action type
\n","type":"text/plain"},"key":"a","value":"update"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"Required: Unique Id of the OKR
\n","type":"text"}]},"url":"https://api.profit.co/app/dao/v6/objective?a=delete&apiKey=action type
\n","type":"text/plain"},"key":"a","value":"delete"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"data
\n","type":"text"},{"key":"objectiveId","value":"Required: Unique Id of the OKR
\n","type":"text"}]},"url":"https://api.profit.co/app/dao/v6/keyresult?a=save&apiKey=action type
\n","type":"text/plain"},"key":"a","value":"save"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"customer satisfaction
\",\"value\":0,\"keyResultStartValue\":0,\"keyResultEndValue\":100,\"defaultMeasureName\":null,\"defaultMeasureId\":null,\"keyResultStatusName\":\"Not Started\",\"keyResultStatusId\":5,\"keyResultTypeName\":\"Percentage Tracked\",\"measurementTypeName\":\"Numeric\",\"measurementTypeId\":1}","type":"text"},{"key":"modifiedFields","value":"[\"isAssignAsObj\",\"keyResultTypeName\"]\n","type":"text"},{"key":"objectiveId","value":"action type
\n","type":"text/plain"},"key":"a","value":"save"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"action type
\n","type":"text/plain"},"key":"a","value":"save"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"action type
\n","type":"text/plain"},"key":"a","value":"save"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"action type
\n","type":"text/plain"},"key":"a","value":"save"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"action type
\n","type":"text/plain"},"key":"a","value":"save"},{"description":{"content":"Required: API key of your Profit.co Account
\n","type":"text/plain"},"key":"apiKey","value":"Required: Access key of your Profit.co Account
\n","type":"text/plain"},"key":"accessKey","value":"Required: KeyResult details to be created
\n","type":"text"},{"key":"objectiveId","value":"