Models

KeyResult

object

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

descriptionstringrequired

typestringNumericalTrue/FalseCurrencyTaskKPIrequired

targetValuenumberrequired

initialValuenumberrequired

unitstringrequired

updatenumberrequired

progressnumberrequired

deadlinestringNo Custom DeadlineHard DeadlineHard and Soft Deadlinerequired

hardDeadlinestring<date-time>required

softDeadlinestring<date-time>required

statusstringrequired

weightstringrequired

ownerEmployeerequired

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

short_descriptionstring

descriptionstring

startedWorkOnstring<date-time>

endWorkstring<date-time>

payPeriodstringNONEBI_WEEKLYWEEKLYTWICE_PER_MONTHMONTHLY

Example

WEEKLY

billRateValuenumber

minimumBillingRatenumber

billRateCurrencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWL

Example

USD

reWeeklyLimitnumber

offerDatestring<date-time>

acceptDatestring<date-time>

rejectDatestring<date-time>

employeeLevelstring

anonymousBonusboolean

averageIncomenumberrequired

averageBonusnumberrequired

totalWorkHoursnumberrequired

averageExpensesnumberrequired

show_anonymous_bonusboolean

show_average_bonusboolean

show_average_expensesboolean

show_average_incomeboolean

show_billrateboolean

show_payperiodboolean

show_start_work_onboolean

isJobSearchActiveboolean

linkedInUrlstring

facebookUrlstring

instagramUrlstring

twitterUrlstring

githubUrlstring

gitlabUrlstring

upworkUrlstring

stackoverflowUrlstring

isVerifiedboolean

isVettedboolean

totalJobsnumberrequired

jobSuccessnumberrequired

profile_linkstring

isTrackingEnabledboolean

isOnlineboolean

isAwaystringfalse

isTrackingTimeboolean

allowScreenshotCaptureboolean

allowManualTimeboolean

allowModifyTimeboolean

allowDeleteTimeboolean

allowAgentAppExitboolean

allowLogoutFromAgentAppboolean

trackKeyboardMouseActivityboolean

trackAllDisplaysboolean

upworkIdstring

linkedInIdstring

userIdstringrequired

contactIdstringrequired

organizationPositionIdstringrequired

ownerIdstringrequired

leadEmployeerequired

Same fields as owner

leadIdstringrequired

projectOrganizationProjectrequired

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

startDatestring

endDatestring

billingstringRATEFLAT_FEEMILESTONES

Example

FLAT_FEE

currencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWL

Example

USD

publicboolean

ownerstringCLIENTINTERNAL

Example

CLIENT

taskListTypestringGRIDSPRINTrequired

Example

GRID

codestring

descriptionstring

colorstring

billableboolean

billingFlatboolean

openSourceboolean

projectUrlstring

openSourceProjectUrlstring

budgetnumber

budgetTypestringhourscost

imageUrlstring

iconstring

statusstringopenin-progresscompletedcancelledcustomopen

isTasksAutoSyncboolean

isTasksAutoSyncOnLabelboolean

syncTagstring

archiveTasksInnumber

closeTasksInnumber

organizationContactIdstring

imageIdstring

defaultAssigneeIdstring

projectIdstringrequiredread only

taskTaskrequired

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

titlestringrequired

descriptionstring

statusstringrequired

prioritystring

sizestring

issueTypestring

estimatenumber

dueDatestring<date-time>

publicboolean

startDatestring<date-time>

resolvedAtstring<date-time>

versionstring

isDraftboolean

isScreeningTaskboolean

parentTask

Same fields as task

parentIdstring

projectobject

projectIdstring

organizationSprintobject

organizationSprintIdstring

taskStatusobject

taskStatusIdstring

taskSizeobject

taskSizeIdstring

taskPriorityobject

taskPriorityIdstring

taskTypeIssueType

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

valuestringrequired

descriptionstring

iconstring

colorstring

isDefaultbooleanfalse

isSystembooleanfalse

imageIdstring

projectIdstring

organizationTeamIdstring

taskTypeIdstring

tagsArray<array>

membersArray<array>

teamsArray<array>

modulesArray<array>

taskIdstringrequiredread only

kpiGoalKPIrequired

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

descriptionstringrequired

typestringNumericalPercentageCurrencyrequired

unitstringrequired

operatorstringrequired

currentValuenumberrequired

targetValuenumberrequired

leadEmployeerequired

Same fields as owner

leadIdstringrequiredread only

kpiIdstringrequiredread only

goalGoalrequired

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

descriptionstringrequired

deadlinestringrequired

levelstringOrganizationTeamEmployeerequired

progressnumberrequired

ownerTeamOrganizationTeamrequired

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

colorstring

emojistring

teamSizestring

logostring

prefixstring

shareProfileViewbooleantrue

requirePlanToTrackbooleanfalse

publicbooleanfalse

profile_linkstring

imageIdstring

ownerTeamIdstringrequired

ownerEmployeeEmployeerequired

Same fields as owner

ownerEmployeeIdstringrequired

leadEmployeerequired

Same fields as owner

leadIdstringrequired

alignedKeyResultKeyResultrequired

Same fields as KeyResult

alignedKeyResultIdstringrequired

organizationStrategicInitiativeobject

organizationStrategicInitiativeIdstring

keyResultsArray<KeyResult>required

Same fields as KeyResult

goalIdstringrequiredread only

updatesKeyResultUpdaterequired

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

updatenumberrequired

progressnumberrequired

ownerstringrequired

statusstringon trackneeds attentionoff tracknonerequired

keyResultIdstringrequiredread only

Example

{
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "name": "string",
  "description": "string",
  "type": "Numerical",
  "targetValue": 0,
  "initialValue": 0,
  "unit": "string",
  "update": 0,
  "progress": 0,
  "deadline": "No Custom Deadline",
  "hardDeadline": "2024-01-15T09:30:00Z",
  "softDeadline": "2024-01-15T09:30:00Z",
  "status": "string",
  "weight": "string",
  "owner": {
    "deletedAt": "2018-11-21T06:20:32.232Z",
    "createdAt": "2018-11-21T06:20:32.232Z",
    "updatedAt": "2018-11-21T06:20:32.232Z",
    "id": "string",
    "isActive": true,
    "isArchived": false,
    "archivedAt": "2018-11-21T06:20:32.232Z",
    "tenantId": "string",
    "organizationId": "string",
    "short_description": "string",
    "description": "string",
    "startedWorkOn": "2024-01-15T09:30:00Z",
    "endWork": "2024-01-15T09:30:00Z",
    "payPeriod": "WEEKLY",
    "billRateValue": 0,
    "minimumBillingRate": 0,
    "billRateCurrency": "USD",
    "reWeeklyLimit": 0,
    "offerDate": "2024-01-15T09:30:00Z",
    "acceptDate": "2024-01-15T09:30:00Z",
    "rejectDate": "2024-01-15T09:30:00Z",
    "employeeLevel": "string",
    "anonymousBonus": true,
    "averageIncome": 0,
    "averageBonus": 0,
    "totalWorkHours": 0,
    "averageExpenses": 0,
    "show_anonymous_bonus": true,
    "show_average_bonus": true,
    "show_average_expenses": true,
    "show_average_income": true,
    "show_billrate": true,
    "show_payperiod": true,
    "show_start_work_on": true,
    "isJobSearchActive": true,
    "linkedInUrl": "string",
    "facebookUrl": "string",
    "instagramUrl": "string",
    "twitterUrl": "string",
    "githubUrl": "string",
    "gitlabUrl": "string",
    "upworkUrl": "string",
    "stackoverflowUrl": "string",
    "isVerified": true,
    "isVetted": true,
    "totalJobs": 0,
    "jobSuccess": 0,
    "profile_link": "string",
    "isTrackingEnabled": true,
    "isOnline": true,
    "isAway": false,
    "isTrackingTime": true,
    "allowScreenshotCapture": true,
    "allowManualTime": true,
    "allowModifyTime": true,
    "allowDeleteTime": true,
    "allowAgentAppExit": true,
    "allowLogoutFromAgentApp": true,
    "trackKeyboardMouseActivity": true,
    "trackAllDisplays": true,
    "upworkId": "string",
    "linkedInId": "string",
    "userId": "string",
    "contactId": "string",
    "organizationPositionId": "string"
  },
  "ownerId": "string",
  "lead": {},
  "leadId": "string",
  "project": {
    "deletedAt": "2018-11-21T06:20:32.232Z",
    "createdAt": "2018-11-21T06:20:32.232Z",
    "updatedAt": "2018-11-21T06:20:32.232Z",
    "id": "string",
    "isActive": true,
    "isArchived": false,
    "archivedAt": "2018-11-21T06:20:32.232Z",
    "tenantId": "string",
    "organizationId": "string",
    "name": "string",
    "startDate": "string",
    "endDate": "string",
    "billing": "FLAT_FEE",
    "currency": "USD",
    "public": true,
    "owner": "CLIENT",
    "taskListType": "GRID",
    "code": "string",
    "description": "string",
    "color": "string",
    "billable": true,
    "billingFlat": true,
    "openSource": true,
    "projectUrl": "string",
    "openSourceProjectUrl": "string",
    "budget": 0,
    "budgetType": "hours",
    "imageUrl": "string",
    "icon": "string",
    "status": "open",
    "isTasksAutoSync": true,
    "isTasksAutoSyncOnLabel": true,
    "syncTag": "string",
    "archiveTasksIn": 0,
    "closeTasksIn": 0,
    "organizationContactId": "string",
    "imageId": "string",
    "defaultAssigneeId": "string"
  },
  "projectId": "string",
  "task": {
    "deletedAt": "2018-11-21T06:20:32.232Z",
    "createdAt": "2018-11-21T06:20:32.232Z",
    "updatedAt": "2018-11-21T06:20:32.232Z",
    "id": "string",
    "isActive": true,
    "isArchived": false,
    "archivedAt": "2018-11-21T06:20:32.232Z",
    "tenantId": "string",
    "organizationId": "string",
    "title": "string",
    "description": "string",
    "status": "string",
    "priority": "string",
    "size": "string",
    "issueType": "string",
    "estimate": 0,
    "dueDate": "2024-01-15T09:30:00Z",
    "public": true,
    "startDate": "2024-01-15T09:30:00Z",
    "resolvedAt": "2024-01-15T09:30:00Z",
    "version": "string",
    "isDraft": true,
    "isScreeningTask": true,
    "parentId": "string",
    "project": {},
    "projectId": "string",
    "organizationSprint": {},
    "organizationSprintId": "string",
    "taskStatus": {},
    "taskStatusId": "string",
    "taskSize": {},
    "taskSizeId": "string",
    "taskPriority": {},
    "taskPriorityId": "string",
    "taskType": {
      "deletedAt": "2018-11-21T06:20:32.232Z",
      "createdAt": "2018-11-21T06:20:32.232Z",
      "updatedAt": "2018-11-21T06:20:32.232Z",
      "id": "string",
      "isActive": true,
      "isArchived": false,
      "archivedAt": "2018-11-21T06:20:32.232Z",
      "tenantId": "string",
      "organizationId": "string",
      "name": "string",
      "value": "string",
      "description": "string",
      "icon": "string",
      "color": "string",
      "isDefault": false,
      "isSystem": false,
      "imageId": "string",
      "projectId": "string",
      "organizationTeamId": "string"
    },
    "taskTypeId": "string",
    "tags": [
      []
    ],
    "members": [
      []
    ],
    "teams": [
      []
    ],
    "modules": [
      []
    ]
  },
  "taskId": "string",
  "kpi": {
    "deletedAt": "2018-11-21T06:20:32.232Z",
    "createdAt": "2018-11-21T06:20:32.232Z",
    "updatedAt": "2018-11-21T06:20:32.232Z",
    "id": "string",
    "isActive": true,
    "isArchived": false,
    "archivedAt": "2018-11-21T06:20:32.232Z",
    "tenantId": "string",
    "organizationId": "string",
    "name": "string",
    "description": "string",
    "type": "Numerical",
    "unit": "string",
    "operator": "string",
    "currentValue": 0,
    "targetValue": 0,
    "lead": {},
    "leadId": "string"
  },
  "kpiId": "string",
  "goal": {
    "deletedAt": "2018-11-21T06:20:32.232Z",
    "createdAt": "2018-11-21T06:20:32.232Z",
    "updatedAt": "2018-11-21T06:20:32.232Z",
    "id": "string",
    "isActive": true,
    "isArchived": false,
    "archivedAt": "2018-11-21T06:20:32.232Z",
    "tenantId": "string",
    "organizationId": "string",
    "name": "string",
    "description": "string",
    "deadline": "string",
    "level": "Organization",
    "progress": 0,
    "ownerTeam": {
      "deletedAt": "2018-11-21T06:20:32.232Z",
      "createdAt": "2018-11-21T06:20:32.232Z",
      "updatedAt": "2018-11-21T06:20:32.232Z",
      "id": "string",
      "isActive": true,
      "isArchived": false,
      "archivedAt": "2018-11-21T06:20:32.232Z",
      "tenantId": "string",
      "organizationId": "string",
      "name": "string",
      "color": "string",
      "emoji": "string",
      "teamSize": "string",
      "logo": "string",
      "prefix": "string",
      "shareProfileView": true,
      "requirePlanToTrack": false,
      "public": false,
      "profile_link": "string",
      "imageId": "string"
    },
    "ownerTeamId": "string",
    "ownerEmployee": {},
    "ownerEmployeeId": "string",
    "lead": {},
    "leadId": "string",
    "alignedKeyResultId": "string",
    "organizationStrategicInitiative": {},
    "organizationStrategicInitiativeId": "string",
    "keyResults": []
  },
  "goalId": "string",
  "updates": {
    "deletedAt": "2018-11-21T06:20:32.232Z",
    "createdAt": "2018-11-21T06:20:32.232Z",
    "updatedAt": "2018-11-21T06:20:32.232Z",
    "id": "string",
    "isActive": true,
    "isArchived": false,
    "archivedAt": "2018-11-21T06:20:32.232Z",
    "tenantId": "string",
    "organizationId": "string",
    "update": 0,
    "progress": 0,
    "owner": "string",
    "status": "on track",
    "keyResultId": "string"
  }
}

Stack Overflow Website Demo