API Quick Reference: Project Settings – Kantata Knowledge Base

Learn about the API fields that correspond to Project Settings.

Default Account Permissions: Account Administrator

Overview

This article provides a list of the API fields and endpoints corresponding to Project Settings to help you get started with the API.

Most project settings are fields on the workspace object and can be set using either the create project endpoint or the update workspace endpoint. Some project settings must be set via other endpoints. Additionally, some project settings are not available in the API.

For the full documentation, see the Kantata OX API Documentation.

Note: Unless noted otherwise, the fields in the tables below are fields in the workspace object.

General

Field	How to set via the API
Project name	`title`
Start project in Estimate stage	`stage`
I am the Provider / I am the Client	`creator_role`
Provider Name	`consultant_role_name`
Client Name	`client_role_name`
Start Date	`start_date`
Due Date	`due_date`
Description	`description`
Project color	`account_color_id`
Task status set	`task_status_set_id`
Include archived tasks in percentage complete	`exclude_archived_stories_percent_complete`
Include non-billable time on invoices	Not available in the API.

Privacy

Field	How to set via the API
Who can participate	`access_level`
Who Can See Communications	`posts_require_privacy_decision`

Organizations

Field How to set via the API

Organizations

When creating a project, set the organizations field on the workspace object.

To add or update the organizations for an existing project, create or update an Organization Membership.

Estimate Preferences (Legacy)

To create a project from a legacy estimate, set the estimate_scenario_id field when creating the project. You must also specify a start_date for the project.

The ability to assign a user to a estimate scenario resource is not available in the API.

Template

Field	How to set via the API
Select a Project Template	`project_tracker_template_id`
Include weekends as workdays	`project_template_weekends_as_workdays`
Convert checklist items to To Dos	`project_template_checklist_as_todos`
Start Date	`project_template_start_date`
Map template named or unnamed resource and project role	`project_template_assignment_mappings` object

Resource Plan

Not available in the API.

Provider Team

When creating a project, you can add named resources via the participations field.

To add people to an existing project, you can create a participation or send a workspace invitation.

Field How to set via the API

Permission access

Lead

When creating a project, you can set the provider team lead via the primary_maven_id field.

To change the provider or client team lead on an existing project, use the update participation endpoint and set the team_lead field.

Financials

Field	How to set via the API
Enable/disable financial features	`budgeted`
Budget	`price`
Activate expense budgets	Not available in the API.
Include Billable Expenses in Actual Fees Calculation	`actual_fees_includes_expenses`
Include Additional Line Items in Actual Fees Calculation	`actual_fees_includes_additional_line_items`
Target margin	`target_margin`
Currency	`currency`
Rate card	`rate_card_id`
Revenue recognition method	Not available in the API.
Task billing mode	`stories_are_fixed_fee_by_default`
Task default	`tasks_default_non_billable`
Schedule and budget changes must be approved	`change_orders_enabled`
Allow tracking time	`time_trackable`
Require notes on time entries	Not available in the API.
Time entries must be approved before invoicing	When creating a project, you can set the `require_time_approvals` field on the `workspace` object. To change this setting for an existing project, use the toggle time approval setting endpoint.
Expenses must be approved before invoicing	When creating a project, you can set the `require_expense_approvals` field on the `workspace` object. To change this setting for an existing project, use the toggle expense approval setting endpoint.

Invoicing Preferences

Set the invoice_preference object on the workspace object.

Field	How to set via the API
Project Code	`project_code`
Purchase Code	`purchase_order`
Client Invoice Name	`client_invoice_name`
Client Invoice Address	`client_invoice_address`
Provider Invoice Name	`consultant_invoice_name`
Provider Invoice Address	`consultant_invoice_address`

Approvals

Field	How to set via the API
Designated approver	`approver_id`

Groups

Field	How to set via the API
Primary group	`primary_workspace_group_id`
Secondary groups	`workspace_group_ids`

Additional Tabs

Field	How to set via the API
Forms	Not available in the API.
Dynamic Dashboards	`account_insights_mapping_ids`

Custom Fields

Use the custom_fields array on the workspace object to set custom field values.

Other

Project Status

Use the status_key field on the workspace object to set or update the project status. Alternatively, use the create workspace status change endpoint to change the project status. See the Project Status article for a list of project status IDs.

Archive Project

To archive a project, use the archived field on the workspace object—available in the update project endpoint only.

Overview

General

Privacy

Organizations

Estimate Preferences (Legacy)

Template

Resource Plan

Provider Team

Financials

Invoicing Preferences

Approvals

Groups

Additional Tabs

Custom Fields

Other

Project Status

Archive Project

Related Articles