Organization

Create a new Organization for a specific tenant

POST

http://localhost:3000/api/organization

curl -X POST 'http://localhost:3000/api/organization' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "bonusType": "PROFIT_BASED_BONUS",
  "bonusPercentage": 75,
  "defaultValueDateType": "TODAY",
  "regionCode": "string",
  "startWeekOn": "MONDAY",
  "inviteExpiryPeriod": 7,
  "allowEmployeeToSeeTrackedData": true,
  "name": "string",
  "standardWorkHoursPerDay": 1,
  "imageId": "string",
  "upworkOrganizationId": "string",
  "upworkOrganizationName": "string",
  "tags": [
    []
  ],
  "currency": "USD"
}'

const body = `{
  "bonusType": "PROFIT_BASED_BONUS",
  "bonusPercentage": 75,
  "defaultValueDateType": "TODAY",
  "regionCode": "string",
  "startWeekOn": "MONDAY",
  "inviteExpiryPeriod": 7,
  "allowEmployeeToSeeTrackedData": true,
  "name": "string",
  "standardWorkHoursPerDay": 1,
  "imageId": "string",
  "upworkOrganizationId": "string",
  "upworkOrganizationName": "string",
  "tags": [
    []
  ],
  "currency": "USD"
}`;

const response = await fetch('http://localhost:3000/api/organization', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "bonusType": "PROFIT_BASED_BONUS",
  "bonusPercentage": 75,
  "defaultValueDateType": "TODAY",
  "regionCode": "string",
  "startWeekOn": "MONDAY",
  "inviteExpiryPeriod": 7,
  "allowEmployeeToSeeTrackedData": true,
  "name": "string",
  "standardWorkHoursPerDay": 1,
  "imageId": "string",
  "upworkOrganizationId": "string",
  "upworkOrganizationName": "string",
  "tags": [
    []
  ],
  "currency": "USD"
}'''

response = requests.post(
    'http://localhost:3000/api/organization',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "bonusType": "PROFIT_BASED_BONUS",
  "bonusPercentage": 75,
  "defaultValueDateType": "TODAY",
  "regionCode": "string",
  "startWeekOn": "MONDAY",
  "inviteExpiryPeriod": 7,
  "allowEmployeeToSeeTrackedData": true,
  "name": "string",
  "standardWorkHoursPerDay": 1,
  "imageId": "string",
  "upworkOrganizationId": "string",
  "upworkOrganizationName": "string",
  "tags": [
    []
  ],
  "currency": "USD"
}

201

{
  "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",
  "name": "string",
  "currency": "USD",
  "defaultValueDateType": "TODAY",
  "regionCode": "string",
  "startWeekOn": "MONDAY",
  "bonusType": "PROFIT_BASED_BONUS",
  "bonusPercentage": 75,
  "show_income": true,
  "show_profits": true,
  "show_bonuses_paid": true,
  "show_total_hours": true,
  "show_minimum_project_size": true,
  "show_projects_count": true,
  "show_clients_count": true,
  "show_clients": true,
  "show_employees_count": true,
  "inviteExpiryPeriod": 7,
  "upworkOrganizationId": "string",
  "upworkOrganizationName": "string",
  "randomScreenshot": true,
  "trackOnSleep": true,
  "screenshotFrequency": 0,
  "enforced": true,
  "standardWorkHoursPerDay": 1,
  "allowAgentAppExit": true,
  "allowLogoutFromAgentApp": true,
  "trackKeyboardMouseActivity": false,
  "trackAllDisplays": false,
  "allowEmployeeToSeeTrackedData": true,
  "imageId": "string"
}

Body

application/json

bonusTypestringPROFIT_BASED_BONUSREVENUE_BASED_BONUS

The type of bonus, can be one of the defined BonusTypeEnum values.

Example

PROFIT_BASED_BONUS

bonusPercentagenumber

The percentage of profit-based bonus, must be between 0 and 100.

Example

defaultValueDateTypestringTODAYEND_OF_MONTHSTART_OF_MONTH

The default value date type, can be one of the values from DefaultValueDateTypeEnum.

Example

TODAY

regionCodestring

The code representing a specific region (e.g., country or geographical area).

startWeekOnstringMONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY

Specifies which day the week starts on. Must be one of the WeekDaysEnum values.

Example

MONDAY

inviteExpiryPeriodnumber

The default invite expiry period in days.

Example

allowEmployeeToSeeTrackedDataboolean

Allow employees to see their own tracked data (screenshots, activity, app/url history, time logs).

Example

true

namestringrequired

standardWorkHoursPerDaynumber[1, 24]

Standard work hours per day for the organization

imageIdstring

upworkOrganizationIdstring

upworkOrganizationNamestring

tagsArray<array>

currencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWLrequired

Example

USD

Response

201CreatedOrganization

The Organization has been successfully created.

Response fields application/json

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

namestringrequired

The currency used by the organization, must be one of the CurrenciesEnum values.

Example

USD

defaultValueDateTypestringTODAYEND_OF_MONTHSTART_OF_MONTH

The default value date type, can be one of the values from DefaultValueDateTypeEnum.

Example

TODAY

regionCodestring

The code representing a specific region (e.g., country or geographical area).

startWeekOnstringMONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY

Specifies which day the week starts on. Must be one of the WeekDaysEnum values.

Example

MONDAY

bonusTypestringPROFIT_BASED_BONUSREVENUE_BASED_BONUS

The type of bonus, can be one of the defined BonusTypeEnum values.

Example

PROFIT_BASED_BONUS

bonusPercentagenumber

The percentage of profit-based bonus, must be between 0 and 100.

Example

show_incomeboolean

show_profitsboolean

show_bonuses_paidboolean

show_total_hoursboolean

show_minimum_project_sizeboolean

show_projects_countboolean

show_clients_countboolean

show_clientsboolean

show_employees_countboolean

inviteExpiryPeriodnumber

The default invite expiry period in days.

Example

upworkOrganizationIdstring

upworkOrganizationNamestring

randomScreenshotboolean

trackOnSleepboolean

screenshotFrequencynumber

enforcedboolean

standardWorkHoursPerDaynumber[1, 24]

Standard work hours per day for the organization

allowAgentAppExitboolean

Allow employees to exit the Agent app. When disabled, the exit option will be blocked in the Agent app.

Example

true

allowLogoutFromAgentAppboolean

Allow employees to logout from the Agent app. When disabled, the logout option will be blocked in the Agent app.

Example

true

trackKeyboardMouseActivityboolean

Enable comprehensive keyboard and mouse activity tracking for detailed productivity insights.

Example

false

trackAllDisplaysboolean

Track all displays instead of just the primary display. Useful for multi-monitor setups.

Example

false

allowEmployeeToSeeTrackedDataboolean

Allow employees to see their own tracked data (screenshots, activity, app/url history, time logs).

Example

true

imageIdstring

400Bad Request

Invalid input, the response body may contain clues as to what went wrong.

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Authorization

bearerhttp (bearer) in header

Enter JWT token

Stack Overflow Website Demo