JavaScript SDK for CodeX Scripts | Help | Zoho Projects

JavaScript SDK for CodeX Scripts

Codex Scripts in Zoho Projects allow users to customize how the projects and tasks operate. Using these scripts, users can automate validations and actions, integrate external systems, and retrieve or update the data.

Info
CodeX Scripts are supported in all data centers except CN JP and AE.

Codex Scripts give access to objects that hold key details such as current records, fields, and metadata where the script is executed. The "Current" object holds contextual information about the record or environment where the script runs.

Object

current { record, affectedFields, action, org, user, module }
Params:
Name
Description 
record
Current record which is being executed.
affectedFields
Fields that are updated  in the current action.
action
Represents the action being performed, e.g., BEFORE_UPDATE, AFTER_CREATE.
org
Org-specific data.
user
The current user performing the action.
module
The module data (Task, Project) related to the record.


Client SDK Methods

Codex Scripts also provide several client-side methods (actions users can perform) to interact with Zoho Projects data. The below client-side SDK methods interact with records, users, layouts, modules, etc from Zoho Projects portal.

Save Records

client.save(record)  - Save or update a record such as task or project, in the Zoho Projects portal. This method automatically determines whether to create or update the record based on the record ID.
  1. If the record contains an id, the existing record is updated.
  2. If the record does not contain an id, a new record is created for that entity.
Params:
Name
Description 
record
Enter the record to save. E.g. Task, Project.
Response
  1. {
  2. "id":"175513000000135011",
  3. "layoutId":"175513000000027008",
  4. "projectId":"175513000000135011",
  5. "moduleId":"175513000000027005",
  6. "end_date":"2025-12-15",
  7. "hourly_budget":"500.000",
  8. "revenue_budget":"15000.000",
  9. "billing_method":"2",
  10. "is_public_project":false,
  11. "description":"<div>Revamp of Zylker's client portal.</div>",
  12. "is_strict_project":true,
  13. "cost_per_hour":"500.000",
  14. "currency":"INR",
  15. "tracking_method":"1",
  16. "budget_type":"5",
  17. "start_date":"2025-08-01",
  18. "owner":"175513000000060003",
  19. "project_type":"active",
  20. "created_time":"1726215358660",
  21. "is_rollup_project":false,
  22. "created_by":"175513000000060003",
  23. "cost_budget":"10000.000",
  24. "percent_complete":"17",
  25. "rate_per_hour":"1000.000",
  26. "last_updated_time":"1749370606429",
  27. "completed_time":null,
  28. "name":"Zylker Website Revamp",
  29. "updated_by":"175513000000060004",
  30. "project_group":"175513000000025001",
  31. "fixed_cost":"0.000",
  32. "status":"175513000000027104"
  33. }

Retrieve Record by ID

client.getRecordById(moduleId, id) - Retrieve a record from the Zoho Projects portal using its ID.

Params:
Name
Description 
moduleId
Enter the ID of the current module being executed.
id
Enter the record ID.
Response
  1.  {

  3.   "id": "214815000000120442",

  5.   "layoutId": "214815000000111729",

  7.   "projectId": "214815000000120442",

  9.   "moduleId": "214815000000027005",

  11.   "end_date": "1755196800000",

  13.   "hourly_budget": "120.000",

  15.   "revenue_budget": "85000.000",

  17.   "billing_method": "4",

  19.   "cf_decimal": "7.50",

  21.   "is_public_project": false,

  23.   "cf_number": "456",

  25.   "description": "Mobile app development for Zylker Retail.",

  27.   "is_strict_project": true,

  29.   "cf_email": "monica.hemsworth@zylker.com",

  31.   "cost_per_hour": "75.000",

  33.   "cf_multi_line": "API integration pending <br> \\n Client approval required",

  35.   "cf_currency": "820.5000",

  37.   "currency": "USD",

  39.   "tracking_method": "1",

  41.   "cf_multi_user_picklist": [

  43.     "214815000000117285"

  45.   ],

  47.   "budget_type": "2",

  49.   "start_date": "1754524800000",

  51.   "owner": "214815000000117285",

  53.   "project_type": "active",

  55.   "created_time": "1753082475000",

  57.   "cf_pick_list": "214815000000111779",

  59.   "is_rollup_project": false,

  61.   "cf_url": "https://projects.zylker.com/resource-hub",

  63.   "cf_checkbox": true,

  65.   "created_by": "214815000000068003",

  67.   "cost_budget": "60000.000",

  69.   "percent_complete": "25",

  71.   "cf_single_line": "Initial phase completed",

  73.   "cf_user_pick_list": null,

  75.   "rate_per_hour": "110.000",

  77.   "cost_budget_threshold": "50000.000",

  79.   "cf_phone": "9876543210",

  81.   "hourly_budget_threshold": "90.000",

  83.   "cf_percentage": "0.85",

  85.   "last_updated_time": "1755738857000",

  87.   "completed_time": null,

  89.   "name": "Zylker Mobile App Dev",

  91.   "updated_by": "214815000000068003",

  93.   "project_group": "214815000000118849",

  95.   "fixed_cost": "10000.000",

  97.   "cf_multi_select": null,

  99.   "cf_date_field": "1754611200000",

  101.   "status": "214815000000027092"

  103. }

Retrieve Modules

client.getModules(index, range) - Retrieve a list of modules (Tasks, Projects) from the Zoho Projects portal.

Params:
Name
Description 
index
Enter the index. E.g. 0,1.
range
Enter the number of modules to retrieve. E.g. 10.

Retrieve Portal Users

client.getPortalUsers(filter)  - Retrieve a list of users from the Zoho Projects portal.

Params:
Name
Description 
filter
Enter the filter criteria.
Sample Filter Object
  1. {
  2. active: true|false
  3. }

Response:

  2. [
  3.   {
  4.     "name": "Monica Hemsworth",
  5.     "email": "monica.hemsworth@zylker.com",
  6.     "zuid": "96901457",
  7.     "role": "Administrator",
  8.     "roleId": "214815000000068005",
  9.     "profileId": "214815000000068436",
  10.     "companyId": null,
  11.     "client": false,
  12.     "id": "214815000000068003"
  13.   },
  14.   {
  15.     "name": "Chloe Tiff",
  16.     "email": "chloe.t@zylker.com",
  17.     "zuid": "90707086",
  18.     "role": "Administrator",
  19.     "roleId": "214815000000068005",
  20.     "profileId": "214815000000068439",
  21.     "companyId": null,
  22.     "client": false,
  23.     "id": "214815000000117285"
  24.   },
  25.   {
  26.     "name": "Patrick Simon",
  27.     "email": "patrick.simon@zylker.com",
  28.     "zuid": "91617413",
  29.     "role": "Employee",
  30.     "roleId": "214815000000068009",
  31.     "profileId": "214815000000068445",
  32.     "companyId": null,
  33.     "client": false,
  34.     "id": "214815000000117291"
  35.   }
  36. ]

Retrieve Portal User by ID

client.getPortalUsersById(id)  - Retrieve a portal user from the Zoho Projects portal.

Params:
Name
Description 
id
Enter the user ID.
Response
  1. {
  2.   "name": "Monica Hemsworth",
  3.   "email": "monica.hemsworth@zylker.com",
  4.   "zuid": "96901457",
  5.   "role": "Administrator",
  6.   "roleId": "214815000000068005",
  7.   "profileId": "214815000000068436",
  8.   "companyId": null,
  9.   "client": false,
  10.   "id": "214815000000068003"
  11. }
 

Retrieve Client Users

client.getClientUsers(filter) - Retrieve a list of client users from the Zoho Projects portal.

Params:
Name
Description 
filter
Enter the filter criteria.
Sample Filter Object
  1. {
  2. active: true|false
  3. }

Response

  2. [
  3.   {
  4.     "name": "Monica Hemsworth",
  5.     "email": "monica.hemsworth@zylker.com",
  6.     "zuid": "106992208",
  7.     "role": null,
  8.     "roleId": null,
  9.     "profileId": null,
  10.     "companyId": null,
  11.     "client": true,
  12.     "id": "214815000000125051"
  13.   },
  14.   {
  15.     "name": "Patrick Simon",
  16.     "email": "patrick.simon@zylker.com",
  17.     "zuid": "106992208",
  18.     "role": null,
  19.     "roleId": null,
  20.     "profileId": null,
  21.     "companyId": null,
  22.     "client": true,
  23.     "id": "214815000000125051"
  24.   }
  25. ]

Retrieve Client User by ID

client.getClientUserById(id) - Retrieve a client user from the Zoho Projects portal.

Params:

Name
Description 
id
Enter the client user ID.

Response
  1. {
  2.   "name": "Monica Hemsworth",
  3.   "email": "monica.hemsworth@zylker.com",
  4.   "zuid": "106992208",
  5.   "role": null,
  6.   "roleId": null,
  7.   "profileId": null,
  8.   "companyId": null,
  9.   "client": true,
  10.   "id": "214815000000125051"
  11. }

Retrieve Client Companies

client.getClientCompanies(filter, range, index) - Retrieve a list of client companies from the Zoho Projects portal.
Params:

Name
Description 
filter
Enter the filter criteria.
range
Enter the number of client companies to retrieve. E.g. 10.
index number
Enter the index. E.g. 0,1.
Sample Filter Object
  1. {
  2.   "project": projectId
  3. }
Response
  1. [
  2.   {
  3.     "id": "214815000000125015",
  4.     "name": "Zylker Inc",
  5.     "customerType": 1,
  6.     "addressFirstLine": "",
  7.     "addressSecondLine": "",
  8.     "city": "",
  9.     "state": "",
  10.     "country": "",
  11.     "zipCode": "",
  12.     "webAddress": "",
  13.     "zohoCRMAccountId": null,
  14.     "currencyCode": null,
  15.     "updateTime": null
  16.   },
  17.   {
  18.     "id": "214815000000125016",
  19.     "name": "Zylker Inc",
  20.     "customerType": 1,
  21.     "addressFirstLine": "",
  22.     "addressSecondLine": "",
  23.     "city": "",
  24.     "state": "",
  25.     "country": "",
  26.     "zipCode": "",
  27.     "webAddress": "",
  28.     "zohoCRMAccountId": null,
  29.     "currencyCode": null,
  30.     "updateTime": null
  31.   }
  32. ]

Retrieve Client Company by ID

client.getClientCompanyById(id) - Retrieve a client company from the Zoho Projects portal.

Params:
Name
Description 
id
Enter the client company ID.
Response

  2. {
  3.   "id": "214815000000125057",
  4.   "name": "Zylker Solutions",
  5.   "addressFirstLine": "",
  6.   "addressSecondLine": "",
  7.   "city": "",
  8.   "state": "",
  9.   "country": "",
  10.   "zipCode": "",
  11.   "webAddress": "",
  12.   "zohoCRMAccountId": "-1",
  13.   "updateTime": null
  14. }
  15.  

Retrieve Client Contacts

client.getClientContacts(filter) -  Retrieve a list of client contacts from the Zoho Projects portal.

Params:
Name
Description 
filter
Enter the filter criteria.
Sample Filter Object
  1. {
  2. active: true|false
  3. }
Response

  2. [
  3.   {
  4.     "name": "Monica Hemsworth",
  5.     "email": "monica.hemsworth@zylker.com",
  6.     "zuid": null,
  7.     "role": null,
  8.     "roleId": null,
  9.     "profileId": null,
  10.     "companyId": null,
  11.     "client": true,
  12.     "id": "214815000000126133"
  13.   },
  14.   {
  15.     "name": "Chloe Tiff",
  16.     "email": "chloe.tiff@zylker.com",
  17.     "zuid": null,
  18.     "role": null,
  19.     "roleId": null,
  20.     "profileId": null,
  21.     "companyId": null,
  22.     "client": true,
  23.     "id": "214815000000126153"
  24.   }
  25. ]

Retrieve Client Contact by ID

client.getClientContactById(id) - Retrieve a client contact from the Zoho Projects portal.

Params:
Name
Description 
id
Enter the client contact ID.
Response
  1. {
  2.   "id": "214815000000126153",
  3.   "zuid": null,
  4.   "email": "monica.hemsworth@zylker.com",
  5.   "name": "Monica Hemsworth",
  6.   "client": true
  7. }

Retrieve Picklist Options

client.getPicklistOptions(moduleId, layoutId, fieldId) - Retrieve options of a picklist field from a module.
Params:
Name
Description 
moduleId
Enter the module ID.
layoutId
Enter the layout ID.
fieldId
Enter the picklist field ID.

Response

  2. [
  3.   {
  4.     "id": "214815000000111775",
  5.     "value": "5"
  6.   },
  7.   {
  8.     "id": "214815000000111787",
  9.     "value": "1"
  10.   },
  11.   {
  12.     "id": "214815000000111789",
  13.     "value": "2"
  14.   },
  15.   {
  16.     "id": "214815000000111791",
  17.     "value": "3"
  18.   },
  19.   {
  20.     "id": "214815000000111793",
  21.     "value": "4"
  22.   }
  23. ]

Retrieve Status Details

client.getStatusDetails(moduleId, layoutId, statusId) - Retrieve status details from a module.

Params:
Name
Description 
moduleId
Enter the module ID.
layoutId
Enter the layout ID.
statusId
Enter the status ID.

HTTP Requests

CodeX Scripts allow you to communicate with external services and APIs using the HttpRequest object. This enables you to send or retrieve data from third-party systems as part of your script logic.
HTTP requests in CodeX Scripts work in combination with Connections, which securely manage authentication details.
Requirements:
  1. Only org-based connections are supported in CodeX Scripts.
  2. Connections that rely on user login credentials are not supported.
  3. Ensure the required connection is created and authorized before using it in a script.
  1. const request = new HttpRequest();
  2. request.url(url);
  3. request.headers(JSON.stringify(headers));
  4. request.body(JSON.stringify(body));
  5. request.connection("connection_link_name");
  6. request.method("GET");
  7. request.params(JSON.stringify(params));
  8. const response = request.execute();
  9. const { status, statusMessage} = response.asJson();
  10. console.log(status); // prints either true or false based on success or failure
  11. console.log(statusMessage.responseText); // prints the API response
  12. console.log(statusMessage.responseCode); // prints the HTTP response code
  13. console.log(statusMessage.responseHeader); // prints the response headers

Variables

Variables in Codex Scripts are used to store and retrieve dynamic values during script execution. Use them to store IDs, names, or any reusable values.
Syntax:
For variable names that follow valid javascript-variable naming conventions:
  1. variables.<var_name>.value
For other valid json keys:
  1. variables["<var_name>"].value
    or
  2. variables['<var_name>'].value