API Documentation
Survey Fields ¶
Survey Fields ¶
The Survey field object represents a question inside of a form within the application.
Data type
The data_type_id attribute can have one of the following integer values:
-
1 (Text field)
-
2 (Number field)
-
3 (Select field)
-
4 (Date field)
-
5 (Multiple select field)
-
7 (Attachment field)
Formatting type
The formatting_type_id attribute can have one of the following integer values:
-
1 (decimal)
-
2 (percentage)
Supported filter params
-
archived (‘true’ or ‘false’)
-
global (‘true’ or ‘false’)
-
name
-
origin_field_id
-
project_id
-
survey_id
GET /api/v2/survey_fields
Requests
GETÂ Â /api/v2/survey_fields
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "38",
"type": "survey_fields",
"attributes": {
"created_at": "2025-12-26T05:20:31.655+01:00",
"updated_at": "2025-12-26T05:20:31.655+01:00",
"name": "Custom field no.33",
"data_type_id": 1,
"required": false,
"description": null,
"archived_at": null,
"aggregation_type_id": null,
"formatting_type_id": null,
"global": null,
"show_in_add_edit_views": true,
"sensitive": false,
"position": 1,
"quick_add_enabled": false,
"customizable_type": "survey_responses"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2492"
}
},
"survey": {
"data": {
"type": "surveys",
"id": "19"
}
},
"origin_field": {
"data": null
},
"options": {
"data": []
},
"custom_field_people": {
"data": []
}
}
}
],
"included": [
{
"id": "19",
"type": "surveys",
"attributes": {
"title": "Survey16",
"description": null,
"public_uuid": "4088bc96-db6f-5a70-b8ff-b3635debc7ed",
"submission_access": "nobody",
"created_at": "2025-12-26T05:20:31.639+01:00",
"updated_at": "2025-12-26T05:20:31.656+01:00"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2492"
}
},
"project": {
"data": {
"type": "projects",
"id": "1870"
}
},
"creator": {
"data": {
"type": "people",
"id": "9226"
}
},
"updater": {
"data": {
"type": "people",
"id": "9226"
}
}
}
},
{
"id": "1870",
"type": "projects",
"attributes": {
"name": "test project",
"number": "1",
"preferences": {},
"project_number": "1",
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": "2025-12-26T05:20:31.000+01:00",
"tag_colors": {},
"archived_at": null,
"created_at": "2025-12-26T05:20:31.628+01:00",
"template": false,
"duplication_status": "idle",
"custom_fields": null,
"task_custom_fields_ids": null,
"task_custom_fields_positions": null,
"page_custom_fields_ids": null,
"page_custom_fields_positions": null,
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2492"
}
},
"company": {
"data": {
"type": "companies",
"id": "6813"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "9227"
}
},
"last_actor": {
"data": {
"type": "people",
"id": "9226"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2329"
}
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"template_object": {
"data": null
}
}
},
{
"id": "9226",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user9073@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": 1,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": null,
"is_user": true,
"user_id": 9151,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-12-26T05:20:31.592+01:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": null,
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 1,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2492"
}
},
"manager": {
"data": null
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "9493"
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"data": []
},
"service_types": {
"data": []
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
{
"id": "6813",
"type": "companies",
"attributes": {
"name": "Client4403",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2025-12-26T05:20:31.624+01:00",
"last_activity_at": "2025-12-26T05:20:31.624+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "CLIE4407",
"domain": null,
"projectless_budgets": false,
"leitweg_id": null,
"buyer_reference": null,
"peppol_id": null,
"default_subsidiary_id": null,
"default_tax_rate_id": null,
"default_document_type_id": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false,
"settings": {},
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2492"
}
},
"default_subsidiary": {
"meta": {
"included": false
}
},
"default_tax_rate": {
"meta": {
"included": false
}
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"integration_exporter_configuration": {
"meta": {
"included": false
}
},
"einvoice_identity": {
"meta": {
"included": false
}
}
}
},
{
"id": "9227",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user9074@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": 3,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": "2025-12-26T05:20:00.000+01:00",
"is_user": true,
"user_id": 9152,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-12-26T05:20:31.612+01:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-12-26T05:20:31.612+01:00",
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 1,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2492"
}
},
"manager": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "6812"
}
},
"subsidiary": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "9494"
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"data": []
},
"service_types": {
"data": []
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
{
"id": "2329",
"type": "workflows",
"attributes": {
"name": "Simple workflow",
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2492"
}
},
"workflow_statuses": {
"data": [
{
"type": "workflow_statuses",
"id": "2899"
}
]
}
}
},
{
"id": "9493",
"type": "roles",
"attributes": {
"base_role_id": 1,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1,
"resolved_permissions": {
"allocations_view": false,
"automations_manage": true,
"bank_accounts_manage": true,
"billables_view": true,
"budgets_view_restricted": true,
"budgets_view_all": true,
"budgets_manage": true,
"budgets_share": true,
"budgets_scenarios_view": true,
"budgets_scenarios_manage": true,
"budgets_scenarios_apply": true,
"companies_view": true,
"companies_manage": true,
"contacts_view": true,
"contacts_manage": true,
"team_members_contact_info_view": true,
"cost_rates_view": true,
"cost_rates_view_inside_subsidiary": true,
"cost_rates_manage": true,
"cost_rates_view_for_subordinates": true,
"custom_fields_manage": true,
"task_custom_fields_manage": true,
"doc_custom_fields_manage": true,
"deals_view_restricted": true,
"deals_view_all": true,
"deals_manage": true,
"deals_share": true,
"deals_scenarios_view": true,
"deals_scenarios_manage": true,
"deals_scenarios_apply": true,
"deals_proposals_delete_signed": true,
"deals_funnel_reports_view": true,
"document_types_and_styles_manage": true,
"docs_manage": true,
"docs_view": true,
"emails_manage": true,
"entitlements_view_self": true,
"entitlements_view_all": true,
"entitlements_manage": true,
"entitlements_view_inside_subsidiary": true,
"events_view": true,
"events_manage": true,
"expenses_view_self": true,
"expenses_view_all": true,
"expenses_view_restricted": true,
"expenses_manage_self": true,
"expenses_manage": true,
"expenses_approve_where_deal_owner": true,
"expenses_approve_restricted": true,
"expenses_approve_all": true,
"financials_locking_manage": true,
"financial_item_reports_view": true,
"holidays_manage": true,
"imports_manage": true,
"integrations_manage_organizational": true,
"integrations_manage_personal": true,
"integrations_manage_task_management": true,
"integrations_view_task_management": true,
"invoices_view_restricted": true,
"invoices_view_all": true,
"invoices_manage_draft": true,
"invoices_manage_finalized": true,
"invoices_limited_manage_finalized": true,
"invoices_copy_to_accounting": true,
"invoices_manage_intercompany": true,
"invoices_send_to_client": true,
"organization_administrate": true,
"organization_polaris_access": true,
"overheads_manage": true,
"payments_view": true,
"payments_manage": true,
"payment_reminders_manage": true,
"payment_reminder_sequences_manage": true,
"placeholders_view": true,
"placeholders_manage": true,
"profitability_view": true,
"projects_view_restricted": true,
"projects_view_all": true,
"projects_manage": true,
"boards_manage": true,
"task_lists_manage": true,
"purchase_orders_view_restricted": true,
"purchase_orders_manage": true,
"resource_requests_view": true,
"resource_requests_create": true,
"resource_requests_resolve": true,
"rate_cards_view": true,
"rate_cards_manage": true,
"report_categories_manage": true,
"insights_view": true,
"insights_manage": true,
"roles_view": true,
"roles_manage": true,
"sales_manage": true,
"service_bookings_view_self": true,
"service_bookings_view_restricted": true,
"service_bookings_view_all": true,
"service_bookings_manage": true,
"service_bookings_view_tentative": true,
"service_types_view": true,
"service_types_manage": true,
"subscription_manage_billing": true,
"subscription_manage_seats": true,
"subscription_manage": true,
"surveys_manage": true,
"tasks_view": true,
"tasks_manage": true,
"tax_rates_manage": true,
"teams_view": true,
"teams_manage": true,
"time_entries_view_all": true,
"time_entries_view_restricted": true,
"time_entries_manage": true,
"time_entries_manage_self": true,
"time_entries_manage_locked": true,
"time_entries_approve_restricted": true,
"time_entries_approve_where_user_is_approver": true,
"time_entries_approve_all": true,
"time_off_bookings_view_all": true,
"time_off_bookings_manage_self": true,
"time_off_bookings_manage_all": true,
"time_off_bookings_approve_all": true,
"time_off_bookings_approve_restricted": true,
"time_off_bookings_view_note": true,
"time_off_bookings_view_inside_subsidiary": true,
"time_reports_view_self": true,
"time_reports_view_all": true,
"time_tracking_policies_manage": true,
"team_members_and_roles_view": true,
"team_members_manage": true,
"team_members_roles_manage": true,
"clients_view": true,
"clients_manage": true,
"contacts_custom_field_values_view": true,
"contacts_custom_field_values_manage": true,
"contacts_sensitive_custom_field_values_view": true,
"contacts_sensitive_custom_field_values_manage": true,
"employees_field_values_view": true,
"employees_field_values_manage": true,
"employees_sensitive_custom_field_values_view": true,
"employees_sensitive_custom_field_values_manage": true,
"clients_deactivation_and_offboarding_manage": true,
"team_members_deactivation_and_offboarding_manage": true,
"webhooks_manage_webhooks": true,
"webhooks_manage_own_zapier_triggers": true,
"workflows_manage": true,
"workload_items_view": true
}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2492"
}
}
}
},
{
"id": "6812",
"type": "companies",
"attributes": {
"name": "Organization2493",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2025-12-26T05:20:31.600+01:00",
"last_activity_at": "2025-12-26T05:20:31.600+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "ORGA",
"domain": null,
"projectless_budgets": false,
"leitweg_id": null,
"buyer_reference": null,
"peppol_id": null,
"default_subsidiary_id": null,
"default_tax_rate_id": null,
"default_document_type_id": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false,
"settings": {},
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2492"
}
},
"default_subsidiary": {
"meta": {
"included": false
}
},
"default_tax_rate": {
"meta": {
"included": false
}
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"integration_exporter_configuration": {
"meta": {
"included": false
}
},
"einvoice_identity": {
"meta": {
"included": false
}
}
}
},
{
"id": "9494",
"type": "roles",
"attributes": {
"base_role_id": 3,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1,
"resolved_permissions": {
"allocations_view": false,
"automations_manage": false,
"bank_accounts_manage": false,
"billables_view": false,
"budgets_view_restricted": false,
"budgets_view_all": false,
"budgets_manage": false,
"budgets_share": false,
"budgets_scenarios_view": false,
"budgets_scenarios_manage": false,
"budgets_scenarios_apply": false,
"companies_view": false,
"companies_manage": false,
"contacts_view": false,
"contacts_manage": false,
"team_members_contact_info_view": true,
"cost_rates_view": false,
"cost_rates_view_inside_subsidiary": false,
"cost_rates_manage": false,
"cost_rates_view_for_subordinates": false,
"custom_fields_manage": false,
"task_custom_fields_manage": false,
"doc_custom_fields_manage": false,
"deals_view_restricted": false,
"deals_view_all": false,
"deals_manage": false,
"deals_share": false,
"deals_scenarios_view": false,
"deals_scenarios_manage": false,
"deals_scenarios_apply": false,
"deals_proposals_delete_signed": false,
"deals_funnel_reports_view": false,
"document_types_and_styles_manage": false,
"docs_manage": true,
"docs_view": true,
"emails_manage": false,
"entitlements_view_self": true,
"entitlements_view_all": false,
"entitlements_manage": false,
"entitlements_view_inside_subsidiary": false,
"events_view": true,
"events_manage": false,
"expenses_view_self": true,
"expenses_view_all": false,
"expenses_view_restricted": false,
"expenses_manage_self": true,
"expenses_manage": false,
"expenses_approve_where_deal_owner": false,
"expenses_approve_restricted": false,
"expenses_approve_all": false,
"financials_locking_manage": false,
"financial_item_reports_view": false,
"holidays_manage": false,
"imports_manage": false,
"integrations_manage_organizational": false,
"integrations_manage_personal": true,
"integrations_manage_task_management": false,
"integrations_view_task_management": true,
"invoices_view_restricted": false,
"invoices_view_all": false,
"invoices_manage_draft": false,
"invoices_manage_finalized": false,
"invoices_limited_manage_finalized": false,
"invoices_copy_to_accounting": false,
"invoices_manage_intercompany": false,
"invoices_send_to_client": false,
"organization_administrate": false,
"organization_polaris_access": false,
"overheads_manage": false,
"payments_view": false,
"payments_manage": false,
"payment_reminders_manage": false,
"payment_reminder_sequences_manage": false,
"placeholders_view": false,
"placeholders_manage": false,
"profitability_view": false,
"projects_view_restricted": true,
"projects_view_all": false,
"projects_manage": false,
"boards_manage": false,
"task_lists_manage": true,
"purchase_orders_view_restricted": false,
"purchase_orders_manage": false,
"resource_requests_view": false,
"resource_requests_create": false,
"resource_requests_resolve": false,
"rate_cards_view": false,
"rate_cards_manage": false,
"report_categories_manage": false,
"insights_view": false,
"insights_manage": false,
"roles_view": false,
"roles_manage": false,
"sales_manage": false,
"service_bookings_view_self": true,
"service_bookings_view_restricted": false,
"service_bookings_view_all": false,
"service_bookings_manage": false,
"service_bookings_view_tentative": false,
"service_types_view": true,
"service_types_manage": false,
"subscription_manage_billing": false,
"subscription_manage_seats": false,
"subscription_manage": false,
"surveys_manage": false,
"tasks_view": true,
"tasks_manage": true,
"tax_rates_manage": false,
"teams_view": true,
"teams_manage": false,
"time_entries_view_all": false,
"time_entries_view_restricted": false,
"time_entries_manage": false,
"time_entries_manage_self": true,
"time_entries_manage_locked": false,
"time_entries_approve_restricted": false,
"time_entries_approve_where_user_is_approver": false,
"time_entries_approve_all": false,
"time_off_bookings_view_all": false,
"time_off_bookings_manage_self": true,
"time_off_bookings_manage_all": false,
"time_off_bookings_approve_all": false,
"time_off_bookings_approve_restricted": false,
"time_off_bookings_view_note": false,
"time_off_bookings_view_inside_subsidiary": false,
"time_reports_view_self": true,
"time_reports_view_all": false,
"time_tracking_policies_manage": false,
"team_members_and_roles_view": false,
"team_members_manage": false,
"team_members_roles_manage": false,
"clients_view": false,
"clients_manage": false,
"contacts_custom_field_values_view": false,
"contacts_custom_field_values_manage": false,
"contacts_sensitive_custom_field_values_view": false,
"contacts_sensitive_custom_field_values_manage": false,
"employees_field_values_view": true,
"employees_field_values_manage": false,
"employees_sensitive_custom_field_values_view": false,
"employees_sensitive_custom_field_values_manage": false,
"clients_deactivation_and_offboarding_manage": false,
"team_members_deactivation_and_offboarding_manage": false,
"webhooks_manage_webhooks": false,
"webhooks_manage_own_zapier_triggers": false,
"workflows_manage": false,
"workload_items_view": true
}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2492"
}
}
}
},
{
"id": "2899",
"type": "workflow_statuses",
"attributes": {
"name": "Closed",
"color_id": "1",
"position": 1,
"category_id": 3
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2492"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2329"
}
}
}
}
],
"links": {
"first": "http://api-test.productive.io/api/v2/survey_fields?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://api-test.productive.io/api/v2/survey_fields?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200
}
}Get survey fieldsGET/api/v2/survey_fields
GET /api/v2/survey_fields/1
Requests
GETÂ Â /api/v2/survey_fields/40
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "40",
"type": "survey_fields",
"attributes": {
"created_at": "2025-12-26T05:20:31.858+01:00",
"updated_at": "2025-12-26T05:20:31.858+01:00",
"name": "Custom field no.35",
"data_type_id": 1,
"required": false,
"description": null,
"archived_at": null,
"aggregation_type_id": null,
"formatting_type_id": null,
"global": null,
"show_in_add_edit_views": true,
"sensitive": false,
"position": 1,
"quick_add_enabled": false,
"customizable_type": "survey_responses"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2493"
}
},
"survey": {
"data": {
"type": "surveys",
"id": "20"
}
},
"origin_field": {
"data": null
},
"options": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
"included": [
{
"id": "20",
"type": "surveys",
"attributes": {
"title": "Survey17",
"description": null,
"public_uuid": "e645aa9c-55c4-5623-b75f-432fcfdf1330",
"submission_access": "nobody",
"created_at": "2025-12-26T05:20:31.852+01:00",
"updated_at": "2025-12-26T05:20:31.859+01:00"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2493"
}
},
"project": {
"data": {
"type": "projects",
"id": "1871"
}
},
"creator": {
"data": {
"type": "people",
"id": "9228"
}
},
"updater": {
"data": {
"type": "people",
"id": "9228"
}
}
}
},
{
"id": "1871",
"type": "projects",
"attributes": {
"name": "test project",
"number": "1",
"preferences": {},
"project_number": "1",
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": "2025-12-26T05:20:31.000+01:00",
"tag_colors": {},
"archived_at": null,
"created_at": "2025-12-26T05:20:31.840+01:00",
"template": false,
"duplication_status": "idle",
"custom_fields": null,
"task_custom_fields_ids": null,
"task_custom_fields_positions": null,
"page_custom_fields_ids": null,
"page_custom_fields_positions": null,
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2493"
}
},
"company": {
"data": {
"type": "companies",
"id": "6815"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "9229"
}
},
"last_actor": {
"data": {
"type": "people",
"id": "9228"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2330"
}
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"template_object": {
"data": null
}
}
},
{
"id": "9228",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user9075@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": 1,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": null,
"is_user": true,
"user_id": 9153,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-12-26T05:20:31.803+01:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": null,
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 1,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2493"
}
},
"manager": {
"data": null
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "9495"
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"data": []
},
"service_types": {
"data": []
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
{
"id": "6815",
"type": "companies",
"attributes": {
"name": "Client4404",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2025-12-26T05:20:31.836+01:00",
"last_activity_at": "2025-12-26T05:20:31.836+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "CLIE4408",
"domain": null,
"projectless_budgets": false,
"leitweg_id": null,
"buyer_reference": null,
"peppol_id": null,
"default_subsidiary_id": null,
"default_tax_rate_id": null,
"default_document_type_id": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false,
"settings": {},
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2493"
}
},
"default_subsidiary": {
"meta": {
"included": false
}
},
"default_tax_rate": {
"meta": {
"included": false
}
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"integration_exporter_configuration": {
"meta": {
"included": false
}
},
"einvoice_identity": {
"meta": {
"included": false
}
}
}
},
{
"id": "9229",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user9076@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": 3,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": "2025-12-26T05:20:00.000+01:00",
"is_user": true,
"user_id": 9154,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-12-26T05:20:31.824+01:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-12-26T05:20:31.824+01:00",
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 1,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2493"
}
},
"manager": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "6814"
}
},
"subsidiary": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "9496"
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"data": []
},
"service_types": {
"data": []
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
{
"id": "2330",
"type": "workflows",
"attributes": {
"name": "Simple workflow",
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2493"
}
},
"workflow_statuses": {
"data": [
{
"type": "workflow_statuses",
"id": "2900"
}
]
}
}
},
{
"id": "9495",
"type": "roles",
"attributes": {
"base_role_id": 1,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1,
"resolved_permissions": {
"allocations_view": false,
"automations_manage": true,
"bank_accounts_manage": true,
"billables_view": true,
"budgets_view_restricted": true,
"budgets_view_all": true,
"budgets_manage": true,
"budgets_share": true,
"budgets_scenarios_view": true,
"budgets_scenarios_manage": true,
"budgets_scenarios_apply": true,
"companies_view": true,
"companies_manage": true,
"contacts_view": true,
"contacts_manage": true,
"team_members_contact_info_view": true,
"cost_rates_view": true,
"cost_rates_view_inside_subsidiary": true,
"cost_rates_manage": true,
"cost_rates_view_for_subordinates": true,
"custom_fields_manage": true,
"task_custom_fields_manage": true,
"doc_custom_fields_manage": true,
"deals_view_restricted": true,
"deals_view_all": true,
"deals_manage": true,
"deals_share": true,
"deals_scenarios_view": true,
"deals_scenarios_manage": true,
"deals_scenarios_apply": true,
"deals_proposals_delete_signed": true,
"deals_funnel_reports_view": true,
"document_types_and_styles_manage": true,
"docs_manage": true,
"docs_view": true,
"emails_manage": true,
"entitlements_view_self": true,
"entitlements_view_all": true,
"entitlements_manage": true,
"entitlements_view_inside_subsidiary": true,
"events_view": true,
"events_manage": true,
"expenses_view_self": true,
"expenses_view_all": true,
"expenses_view_restricted": true,
"expenses_manage_self": true,
"expenses_manage": true,
"expenses_approve_where_deal_owner": true,
"expenses_approve_restricted": true,
"expenses_approve_all": true,
"financials_locking_manage": true,
"financial_item_reports_view": true,
"holidays_manage": true,
"imports_manage": true,
"integrations_manage_organizational": true,
"integrations_manage_personal": true,
"integrations_manage_task_management": true,
"integrations_view_task_management": true,
"invoices_view_restricted": true,
"invoices_view_all": true,
"invoices_manage_draft": true,
"invoices_manage_finalized": true,
"invoices_limited_manage_finalized": true,
"invoices_copy_to_accounting": true,
"invoices_manage_intercompany": true,
"invoices_send_to_client": true,
"organization_administrate": true,
"organization_polaris_access": true,
"overheads_manage": true,
"payments_view": true,
"payments_manage": true,
"payment_reminders_manage": true,
"payment_reminder_sequences_manage": true,
"placeholders_view": true,
"placeholders_manage": true,
"profitability_view": true,
"projects_view_restricted": true,
"projects_view_all": true,
"projects_manage": true,
"boards_manage": true,
"task_lists_manage": true,
"purchase_orders_view_restricted": true,
"purchase_orders_manage": true,
"resource_requests_view": true,
"resource_requests_create": true,
"resource_requests_resolve": true,
"rate_cards_view": true,
"rate_cards_manage": true,
"report_categories_manage": true,
"insights_view": true,
"insights_manage": true,
"roles_view": true,
"roles_manage": true,
"sales_manage": true,
"service_bookings_view_self": true,
"service_bookings_view_restricted": true,
"service_bookings_view_all": true,
"service_bookings_manage": true,
"service_bookings_view_tentative": true,
"service_types_view": true,
"service_types_manage": true,
"subscription_manage_billing": true,
"subscription_manage_seats": true,
"subscription_manage": true,
"surveys_manage": true,
"tasks_view": true,
"tasks_manage": true,
"tax_rates_manage": true,
"teams_view": true,
"teams_manage": true,
"time_entries_view_all": true,
"time_entries_view_restricted": true,
"time_entries_manage": true,
"time_entries_manage_self": true,
"time_entries_manage_locked": true,
"time_entries_approve_restricted": true,
"time_entries_approve_where_user_is_approver": true,
"time_entries_approve_all": true,
"time_off_bookings_view_all": true,
"time_off_bookings_manage_self": true,
"time_off_bookings_manage_all": true,
"time_off_bookings_approve_all": true,
"time_off_bookings_approve_restricted": true,
"time_off_bookings_view_note": true,
"time_off_bookings_view_inside_subsidiary": true,
"time_reports_view_self": true,
"time_reports_view_all": true,
"time_tracking_policies_manage": true,
"team_members_and_roles_view": true,
"team_members_manage": true,
"team_members_roles_manage": true,
"clients_view": true,
"clients_manage": true,
"contacts_custom_field_values_view": true,
"contacts_custom_field_values_manage": true,
"contacts_sensitive_custom_field_values_view": true,
"contacts_sensitive_custom_field_values_manage": true,
"employees_field_values_view": true,
"employees_field_values_manage": true,
"employees_sensitive_custom_field_values_view": true,
"employees_sensitive_custom_field_values_manage": true,
"clients_deactivation_and_offboarding_manage": true,
"team_members_deactivation_and_offboarding_manage": true,
"webhooks_manage_webhooks": true,
"webhooks_manage_own_zapier_triggers": true,
"workflows_manage": true,
"workload_items_view": true
}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2493"
}
}
}
},
{
"id": "6814",
"type": "companies",
"attributes": {
"name": "Organization2494",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2025-12-26T05:20:31.811+01:00",
"last_activity_at": "2025-12-26T05:20:31.812+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "ORGA",
"domain": null,
"projectless_budgets": false,
"leitweg_id": null,
"buyer_reference": null,
"peppol_id": null,
"default_subsidiary_id": null,
"default_tax_rate_id": null,
"default_document_type_id": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false,
"settings": {},
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2493"
}
},
"default_subsidiary": {
"meta": {
"included": false
}
},
"default_tax_rate": {
"meta": {
"included": false
}
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"integration_exporter_configuration": {
"meta": {
"included": false
}
},
"einvoice_identity": {
"meta": {
"included": false
}
}
}
},
{
"id": "9496",
"type": "roles",
"attributes": {
"base_role_id": 3,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1,
"resolved_permissions": {
"allocations_view": false,
"automations_manage": false,
"bank_accounts_manage": false,
"billables_view": false,
"budgets_view_restricted": false,
"budgets_view_all": false,
"budgets_manage": false,
"budgets_share": false,
"budgets_scenarios_view": false,
"budgets_scenarios_manage": false,
"budgets_scenarios_apply": false,
"companies_view": false,
"companies_manage": false,
"contacts_view": false,
"contacts_manage": false,
"team_members_contact_info_view": true,
"cost_rates_view": false,
"cost_rates_view_inside_subsidiary": false,
"cost_rates_manage": false,
"cost_rates_view_for_subordinates": false,
"custom_fields_manage": false,
"task_custom_fields_manage": false,
"doc_custom_fields_manage": false,
"deals_view_restricted": false,
"deals_view_all": false,
"deals_manage": false,
"deals_share": false,
"deals_scenarios_view": false,
"deals_scenarios_manage": false,
"deals_scenarios_apply": false,
"deals_proposals_delete_signed": false,
"deals_funnel_reports_view": false,
"document_types_and_styles_manage": false,
"docs_manage": true,
"docs_view": true,
"emails_manage": false,
"entitlements_view_self": true,
"entitlements_view_all": false,
"entitlements_manage": false,
"entitlements_view_inside_subsidiary": false,
"events_view": true,
"events_manage": false,
"expenses_view_self": true,
"expenses_view_all": false,
"expenses_view_restricted": false,
"expenses_manage_self": true,
"expenses_manage": false,
"expenses_approve_where_deal_owner": false,
"expenses_approve_restricted": false,
"expenses_approve_all": false,
"financials_locking_manage": false,
"financial_item_reports_view": false,
"holidays_manage": false,
"imports_manage": false,
"integrations_manage_organizational": false,
"integrations_manage_personal": true,
"integrations_manage_task_management": false,
"integrations_view_task_management": true,
"invoices_view_restricted": false,
"invoices_view_all": false,
"invoices_manage_draft": false,
"invoices_manage_finalized": false,
"invoices_limited_manage_finalized": false,
"invoices_copy_to_accounting": false,
"invoices_manage_intercompany": false,
"invoices_send_to_client": false,
"organization_administrate": false,
"organization_polaris_access": false,
"overheads_manage": false,
"payments_view": false,
"payments_manage": false,
"payment_reminders_manage": false,
"payment_reminder_sequences_manage": false,
"placeholders_view": false,
"placeholders_manage": false,
"profitability_view": false,
"projects_view_restricted": true,
"projects_view_all": false,
"projects_manage": false,
"boards_manage": false,
"task_lists_manage": true,
"purchase_orders_view_restricted": false,
"purchase_orders_manage": false,
"resource_requests_view": false,
"resource_requests_create": false,
"resource_requests_resolve": false,
"rate_cards_view": false,
"rate_cards_manage": false,
"report_categories_manage": false,
"insights_view": false,
"insights_manage": false,
"roles_view": false,
"roles_manage": false,
"sales_manage": false,
"service_bookings_view_self": true,
"service_bookings_view_restricted": false,
"service_bookings_view_all": false,
"service_bookings_manage": false,
"service_bookings_view_tentative": false,
"service_types_view": true,
"service_types_manage": false,
"subscription_manage_billing": false,
"subscription_manage_seats": false,
"subscription_manage": false,
"surveys_manage": false,
"tasks_view": true,
"tasks_manage": true,
"tax_rates_manage": false,
"teams_view": true,
"teams_manage": false,
"time_entries_view_all": false,
"time_entries_view_restricted": false,
"time_entries_manage": false,
"time_entries_manage_self": true,
"time_entries_manage_locked": false,
"time_entries_approve_restricted": false,
"time_entries_approve_where_user_is_approver": false,
"time_entries_approve_all": false,
"time_off_bookings_view_all": false,
"time_off_bookings_manage_self": true,
"time_off_bookings_manage_all": false,
"time_off_bookings_approve_all": false,
"time_off_bookings_approve_restricted": false,
"time_off_bookings_view_note": false,
"time_off_bookings_view_inside_subsidiary": false,
"time_reports_view_self": true,
"time_reports_view_all": false,
"time_tracking_policies_manage": false,
"team_members_and_roles_view": false,
"team_members_manage": false,
"team_members_roles_manage": false,
"clients_view": false,
"clients_manage": false,
"contacts_custom_field_values_view": false,
"contacts_custom_field_values_manage": false,
"contacts_sensitive_custom_field_values_view": false,
"contacts_sensitive_custom_field_values_manage": false,
"employees_field_values_view": true,
"employees_field_values_manage": false,
"employees_sensitive_custom_field_values_view": false,
"employees_sensitive_custom_field_values_manage": false,
"clients_deactivation_and_offboarding_manage": false,
"team_members_deactivation_and_offboarding_manage": false,
"webhooks_manage_webhooks": false,
"webhooks_manage_own_zapier_triggers": false,
"workflows_manage": false,
"workload_items_view": true
}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2493"
}
}
}
},
{
"id": "2900",
"type": "workflow_statuses",
"attributes": {
"name": "Closed",
"color_id": "1",
"position": 1,
"category_id": 3
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2493"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2330"
}
}
}
}
],
"meta": {}
}Gets a survey fieldGET/api/v2/survey_fields/{id}
URI Parameters
- id
number(required) Example: 1survey field id
POST /api/v2/survey_fields
Requests
POSTÂ Â /api/v2/survey_fields
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "survey_fields",
"attributes": {
"name": "Just an another question for survey",
"survey_id": 21,
"customizable_type": "survey_responses",
"data_type_id": 1
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "41",
"type": "survey_fields",
"attributes": {
"created_at": "2025-12-26T05:20:32.037+01:00",
"updated_at": "2025-12-26T05:20:32.037+01:00",
"name": "Just an another question for survey",
"data_type_id": 1,
"required": false,
"description": null,
"archived_at": null,
"aggregation_type_id": null,
"formatting_type_id": null,
"global": true,
"show_in_add_edit_views": true,
"sensitive": false,
"position": 1,
"quick_add_enabled": false,
"customizable_type": "survey_responses"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2494"
}
},
"survey": {
"data": {
"type": "surveys",
"id": "21"
}
},
"origin_field": {
"data": null
},
"options": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
"included": [
{
"id": "21",
"type": "surveys",
"attributes": {
"title": "Survey18",
"description": null,
"public_uuid": "134ce334-2824-5508-9561-76e4e9eb2268",
"submission_access": "nobody",
"created_at": "2025-12-26T05:20:32.019+01:00",
"updated_at": "2025-12-26T05:20:32.038+01:00"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2494"
}
},
"project": {
"data": {
"type": "projects",
"id": "1872"
}
},
"creator": {
"data": {
"type": "people",
"id": "9230"
}
},
"updater": {
"data": {
"type": "people",
"id": "9230"
}
}
}
},
{
"id": "1872",
"type": "projects",
"attributes": {
"name": "test project",
"number": "1",
"preferences": {},
"project_number": "1",
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": "2025-12-26T05:20:32.000+01:00",
"tag_colors": {},
"archived_at": null,
"created_at": "2025-12-26T05:20:32.007+01:00",
"template": false,
"duplication_status": "idle",
"custom_fields": null,
"task_custom_fields_ids": null,
"task_custom_fields_positions": null,
"page_custom_fields_ids": null,
"page_custom_fields_positions": null,
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2494"
}
},
"company": {
"data": {
"type": "companies",
"id": "6817"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "9231"
}
},
"last_actor": {
"data": {
"type": "people",
"id": "9230"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2331"
}
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"template_object": {
"data": null
}
}
},
{
"id": "9230",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user9077@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": 1,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": null,
"is_user": true,
"user_id": 9155,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-12-26T05:20:31.970+01:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": null,
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 1,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2494"
}
},
"manager": {
"data": null
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "9497"
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"data": []
},
"service_types": {
"data": []
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
{
"id": "6817",
"type": "companies",
"attributes": {
"name": "Client4405",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2025-12-26T05:20:32.003+01:00",
"last_activity_at": "2025-12-26T05:20:32.003+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "CLIE4409",
"domain": null,
"projectless_budgets": false,
"leitweg_id": null,
"buyer_reference": null,
"peppol_id": null,
"default_subsidiary_id": null,
"default_tax_rate_id": null,
"default_document_type_id": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false,
"settings": {},
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2494"
}
},
"default_subsidiary": {
"meta": {
"included": false
}
},
"default_tax_rate": {
"meta": {
"included": false
}
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"integration_exporter_configuration": {
"meta": {
"included": false
}
},
"einvoice_identity": {
"meta": {
"included": false
}
}
}
},
{
"id": "9231",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user9078@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": 3,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": "2025-12-26T05:20:00.000+01:00",
"is_user": true,
"user_id": 9156,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-12-26T05:20:31.991+01:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-12-26T05:20:31.991+01:00",
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 1,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2494"
}
},
"manager": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "6816"
}
},
"subsidiary": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "9498"
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"data": []
},
"service_types": {
"data": []
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
{
"id": "2331",
"type": "workflows",
"attributes": {
"name": "Simple workflow",
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2494"
}
},
"workflow_statuses": {
"data": [
{
"type": "workflow_statuses",
"id": "2901"
}
]
}
}
},
{
"id": "9497",
"type": "roles",
"attributes": {
"base_role_id": 1,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1,
"resolved_permissions": {
"allocations_view": false,
"automations_manage": true,
"bank_accounts_manage": true,
"billables_view": true,
"budgets_view_restricted": true,
"budgets_view_all": true,
"budgets_manage": true,
"budgets_share": true,
"budgets_scenarios_view": true,
"budgets_scenarios_manage": true,
"budgets_scenarios_apply": true,
"companies_view": true,
"companies_manage": true,
"contacts_view": true,
"contacts_manage": true,
"team_members_contact_info_view": true,
"cost_rates_view": true,
"cost_rates_view_inside_subsidiary": true,
"cost_rates_manage": true,
"cost_rates_view_for_subordinates": true,
"custom_fields_manage": true,
"task_custom_fields_manage": true,
"doc_custom_fields_manage": true,
"deals_view_restricted": true,
"deals_view_all": true,
"deals_manage": true,
"deals_share": true,
"deals_scenarios_view": true,
"deals_scenarios_manage": true,
"deals_scenarios_apply": true,
"deals_proposals_delete_signed": true,
"deals_funnel_reports_view": true,
"document_types_and_styles_manage": true,
"docs_manage": true,
"docs_view": true,
"emails_manage": true,
"entitlements_view_self": true,
"entitlements_view_all": true,
"entitlements_manage": true,
"entitlements_view_inside_subsidiary": true,
"events_view": true,
"events_manage": true,
"expenses_view_self": true,
"expenses_view_all": true,
"expenses_view_restricted": true,
"expenses_manage_self": true,
"expenses_manage": true,
"expenses_approve_where_deal_owner": true,
"expenses_approve_restricted": true,
"expenses_approve_all": true,
"financials_locking_manage": true,
"financial_item_reports_view": true,
"holidays_manage": true,
"imports_manage": true,
"integrations_manage_organizational": true,
"integrations_manage_personal": true,
"integrations_manage_task_management": true,
"integrations_view_task_management": true,
"invoices_view_restricted": true,
"invoices_view_all": true,
"invoices_manage_draft": true,
"invoices_manage_finalized": true,
"invoices_limited_manage_finalized": true,
"invoices_copy_to_accounting": true,
"invoices_manage_intercompany": true,
"invoices_send_to_client": true,
"organization_administrate": true,
"organization_polaris_access": true,
"overheads_manage": true,
"payments_view": true,
"payments_manage": true,
"payment_reminders_manage": true,
"payment_reminder_sequences_manage": true,
"placeholders_view": true,
"placeholders_manage": true,
"profitability_view": true,
"projects_view_restricted": true,
"projects_view_all": true,
"projects_manage": true,
"boards_manage": true,
"task_lists_manage": true,
"purchase_orders_view_restricted": true,
"purchase_orders_manage": true,
"resource_requests_view": true,
"resource_requests_create": true,
"resource_requests_resolve": true,
"rate_cards_view": true,
"rate_cards_manage": true,
"report_categories_manage": true,
"insights_view": true,
"insights_manage": true,
"roles_view": true,
"roles_manage": true,
"sales_manage": true,
"service_bookings_view_self": true,
"service_bookings_view_restricted": true,
"service_bookings_view_all": true,
"service_bookings_manage": true,
"service_bookings_view_tentative": true,
"service_types_view": true,
"service_types_manage": true,
"subscription_manage_billing": true,
"subscription_manage_seats": true,
"subscription_manage": true,
"surveys_manage": true,
"tasks_view": true,
"tasks_manage": true,
"tax_rates_manage": true,
"teams_view": true,
"teams_manage": true,
"time_entries_view_all": true,
"time_entries_view_restricted": true,
"time_entries_manage": true,
"time_entries_manage_self": true,
"time_entries_manage_locked": true,
"time_entries_approve_restricted": true,
"time_entries_approve_where_user_is_approver": true,
"time_entries_approve_all": true,
"time_off_bookings_view_all": true,
"time_off_bookings_manage_self": true,
"time_off_bookings_manage_all": true,
"time_off_bookings_approve_all": true,
"time_off_bookings_approve_restricted": true,
"time_off_bookings_view_note": true,
"time_off_bookings_view_inside_subsidiary": true,
"time_reports_view_self": true,
"time_reports_view_all": true,
"time_tracking_policies_manage": true,
"team_members_and_roles_view": true,
"team_members_manage": true,
"team_members_roles_manage": true,
"clients_view": true,
"clients_manage": true,
"contacts_custom_field_values_view": true,
"contacts_custom_field_values_manage": true,
"contacts_sensitive_custom_field_values_view": true,
"contacts_sensitive_custom_field_values_manage": true,
"employees_field_values_view": true,
"employees_field_values_manage": true,
"employees_sensitive_custom_field_values_view": true,
"employees_sensitive_custom_field_values_manage": true,
"clients_deactivation_and_offboarding_manage": true,
"team_members_deactivation_and_offboarding_manage": true,
"webhooks_manage_webhooks": true,
"webhooks_manage_own_zapier_triggers": true,
"workflows_manage": true,
"workload_items_view": true
}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2494"
}
}
}
},
{
"id": "6816",
"type": "companies",
"attributes": {
"name": "Organization2495",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2025-12-26T05:20:31.978+01:00",
"last_activity_at": "2025-12-26T05:20:31.978+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "ORGA",
"domain": null,
"projectless_budgets": false,
"leitweg_id": null,
"buyer_reference": null,
"peppol_id": null,
"default_subsidiary_id": null,
"default_tax_rate_id": null,
"default_document_type_id": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false,
"settings": {},
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2494"
}
},
"default_subsidiary": {
"meta": {
"included": false
}
},
"default_tax_rate": {
"meta": {
"included": false
}
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"integration_exporter_configuration": {
"meta": {
"included": false
}
},
"einvoice_identity": {
"meta": {
"included": false
}
}
}
},
{
"id": "9498",
"type": "roles",
"attributes": {
"base_role_id": 3,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1,
"resolved_permissions": {
"allocations_view": false,
"automations_manage": false,
"bank_accounts_manage": false,
"billables_view": false,
"budgets_view_restricted": false,
"budgets_view_all": false,
"budgets_manage": false,
"budgets_share": false,
"budgets_scenarios_view": false,
"budgets_scenarios_manage": false,
"budgets_scenarios_apply": false,
"companies_view": false,
"companies_manage": false,
"contacts_view": false,
"contacts_manage": false,
"team_members_contact_info_view": true,
"cost_rates_view": false,
"cost_rates_view_inside_subsidiary": false,
"cost_rates_manage": false,
"cost_rates_view_for_subordinates": false,
"custom_fields_manage": false,
"task_custom_fields_manage": false,
"doc_custom_fields_manage": false,
"deals_view_restricted": false,
"deals_view_all": false,
"deals_manage": false,
"deals_share": false,
"deals_scenarios_view": false,
"deals_scenarios_manage": false,
"deals_scenarios_apply": false,
"deals_proposals_delete_signed": false,
"deals_funnel_reports_view": false,
"document_types_and_styles_manage": false,
"docs_manage": true,
"docs_view": true,
"emails_manage": false,
"entitlements_view_self": true,
"entitlements_view_all": false,
"entitlements_manage": false,
"entitlements_view_inside_subsidiary": false,
"events_view": true,
"events_manage": false,
"expenses_view_self": true,
"expenses_view_all": false,
"expenses_view_restricted": false,
"expenses_manage_self": true,
"expenses_manage": false,
"expenses_approve_where_deal_owner": false,
"expenses_approve_restricted": false,
"expenses_approve_all": false,
"financials_locking_manage": false,
"financial_item_reports_view": false,
"holidays_manage": false,
"imports_manage": false,
"integrations_manage_organizational": false,
"integrations_manage_personal": true,
"integrations_manage_task_management": false,
"integrations_view_task_management": true,
"invoices_view_restricted": false,
"invoices_view_all": false,
"invoices_manage_draft": false,
"invoices_manage_finalized": false,
"invoices_limited_manage_finalized": false,
"invoices_copy_to_accounting": false,
"invoices_manage_intercompany": false,
"invoices_send_to_client": false,
"organization_administrate": false,
"organization_polaris_access": false,
"overheads_manage": false,
"payments_view": false,
"payments_manage": false,
"payment_reminders_manage": false,
"payment_reminder_sequences_manage": false,
"placeholders_view": false,
"placeholders_manage": false,
"profitability_view": false,
"projects_view_restricted": true,
"projects_view_all": false,
"projects_manage": false,
"boards_manage": false,
"task_lists_manage": true,
"purchase_orders_view_restricted": false,
"purchase_orders_manage": false,
"resource_requests_view": false,
"resource_requests_create": false,
"resource_requests_resolve": false,
"rate_cards_view": false,
"rate_cards_manage": false,
"report_categories_manage": false,
"insights_view": false,
"insights_manage": false,
"roles_view": false,
"roles_manage": false,
"sales_manage": false,
"service_bookings_view_self": true,
"service_bookings_view_restricted": false,
"service_bookings_view_all": false,
"service_bookings_manage": false,
"service_bookings_view_tentative": false,
"service_types_view": true,
"service_types_manage": false,
"subscription_manage_billing": false,
"subscription_manage_seats": false,
"subscription_manage": false,
"surveys_manage": false,
"tasks_view": true,
"tasks_manage": true,
"tax_rates_manage": false,
"teams_view": true,
"teams_manage": false,
"time_entries_view_all": false,
"time_entries_view_restricted": false,
"time_entries_manage": false,
"time_entries_manage_self": true,
"time_entries_manage_locked": false,
"time_entries_approve_restricted": false,
"time_entries_approve_where_user_is_approver": false,
"time_entries_approve_all": false,
"time_off_bookings_view_all": false,
"time_off_bookings_manage_self": true,
"time_off_bookings_manage_all": false,
"time_off_bookings_approve_all": false,
"time_off_bookings_approve_restricted": false,
"time_off_bookings_view_note": false,
"time_off_bookings_view_inside_subsidiary": false,
"time_reports_view_self": true,
"time_reports_view_all": false,
"time_tracking_policies_manage": false,
"team_members_and_roles_view": false,
"team_members_manage": false,
"team_members_roles_manage": false,
"clients_view": false,
"clients_manage": false,
"contacts_custom_field_values_view": false,
"contacts_custom_field_values_manage": false,
"contacts_sensitive_custom_field_values_view": false,
"contacts_sensitive_custom_field_values_manage": false,
"employees_field_values_view": true,
"employees_field_values_manage": false,
"employees_sensitive_custom_field_values_view": false,
"employees_sensitive_custom_field_values_manage": false,
"clients_deactivation_and_offboarding_manage": false,
"team_members_deactivation_and_offboarding_manage": false,
"webhooks_manage_webhooks": false,
"webhooks_manage_own_zapier_triggers": false,
"workflows_manage": false,
"workload_items_view": true
}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2494"
}
}
}
},
{
"id": "2901",
"type": "workflow_statuses",
"attributes": {
"name": "Closed",
"color_id": "1",
"position": 1,
"category_id": 3
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2494"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2331"
}
}
}
}
],
"meta": {}
}POSTÂ Â /api/v2/survey_fields
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "survey_fields",
"attributes": {
"name": "Just an another question for survey",
"survey_id": 22,
"customizable_type": "survey_responses",
"data_type_id": null
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/data_type_id"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "is not included in the list",
"source": {
"pointer": "data/attributes/data_type_id"
}
}
]
}Creates a survey fieldPOST/api/v2/survey_fields
URI Parameters
- survey_id
number(required) Example: 1survey id
- data_type_id
number(required) Example: 1data type id
- name
string(required) Example: Survey+Field+namesurvey field name
- origin_field_id
number(optional) Example: 1origin field id
PATCH /api/v2/survey_fields/1
Requests
PATCHÂ Â /api/v2/survey_fields/42
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "survey_fields",
"attributes": {
"name": "New name"
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "42",
"type": "survey_fields",
"attributes": {
"created_at": "2025-12-26T05:20:32.264+01:00",
"updated_at": "2025-12-26T05:20:32.277+01:00",
"name": "New name",
"data_type_id": 1,
"required": false,
"description": null,
"archived_at": null,
"aggregation_type_id": null,
"formatting_type_id": null,
"global": true,
"show_in_add_edit_views": true,
"sensitive": false,
"position": 1,
"quick_add_enabled": false,
"customizable_type": "survey_responses"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2496"
}
},
"survey": {
"data": {
"type": "surveys",
"id": "23"
}
},
"origin_field": {
"data": null
},
"options": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
"included": [
{
"id": "23",
"type": "surveys",
"attributes": {
"title": "Survey20",
"description": null,
"public_uuid": "094f357f-1498-5694-8748-0c3c1714f940",
"submission_access": "nobody",
"created_at": "2025-12-26T05:20:32.258+01:00",
"updated_at": "2025-12-26T05:20:32.278+01:00"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2496"
}
},
"project": {
"data": {
"type": "projects",
"id": "1874"
}
},
"creator": {
"data": {
"type": "people",
"id": "9234"
}
},
"updater": {
"data": {
"type": "people",
"id": "9234"
}
}
}
},
{
"id": "1874",
"type": "projects",
"attributes": {
"name": "test project",
"number": "1",
"preferences": {},
"project_number": "1",
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": "2025-12-26T05:20:32.000+01:00",
"tag_colors": {},
"archived_at": null,
"created_at": "2025-12-26T05:20:32.247+01:00",
"template": false,
"duplication_status": "idle",
"custom_fields": null,
"task_custom_fields_ids": null,
"task_custom_fields_positions": null,
"page_custom_fields_ids": null,
"page_custom_fields_positions": null,
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2496"
}
},
"company": {
"data": {
"type": "companies",
"id": "6821"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "9235"
}
},
"last_actor": {
"data": {
"type": "people",
"id": "9234"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2333"
}
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"template_object": {
"data": null
}
}
},
{
"id": "9234",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user9081@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": 1,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": null,
"is_user": true,
"user_id": 9159,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-12-26T05:20:32.212+01:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": null,
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 1,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2496"
}
},
"manager": {
"data": null
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "9501"
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"data": []
},
"service_types": {
"data": []
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
{
"id": "6821",
"type": "companies",
"attributes": {
"name": "Client4407",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2025-12-26T05:20:32.243+01:00",
"last_activity_at": "2025-12-26T05:20:32.243+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "CLIE4411",
"domain": null,
"projectless_budgets": false,
"leitweg_id": null,
"buyer_reference": null,
"peppol_id": null,
"default_subsidiary_id": null,
"default_tax_rate_id": null,
"default_document_type_id": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false,
"settings": {},
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2496"
}
},
"default_subsidiary": {
"meta": {
"included": false
}
},
"default_tax_rate": {
"meta": {
"included": false
}
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"integration_exporter_configuration": {
"meta": {
"included": false
}
},
"einvoice_identity": {
"meta": {
"included": false
}
}
}
},
{
"id": "9235",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user9082@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": 3,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": "2025-12-26T05:20:00.000+01:00",
"is_user": true,
"user_id": 9160,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-12-26T05:20:32.232+01:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-12-26T05:20:32.232+01:00",
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 1,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2496"
}
},
"manager": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "6820"
}
},
"subsidiary": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "9502"
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"data": []
},
"service_types": {
"data": []
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
{
"id": "2333",
"type": "workflows",
"attributes": {
"name": "Simple workflow",
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2496"
}
},
"workflow_statuses": {
"data": [
{
"type": "workflow_statuses",
"id": "2903"
}
]
}
}
},
{
"id": "9501",
"type": "roles",
"attributes": {
"base_role_id": 1,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1,
"resolved_permissions": {
"allocations_view": false,
"automations_manage": true,
"bank_accounts_manage": true,
"billables_view": true,
"budgets_view_restricted": true,
"budgets_view_all": true,
"budgets_manage": true,
"budgets_share": true,
"budgets_scenarios_view": true,
"budgets_scenarios_manage": true,
"budgets_scenarios_apply": true,
"companies_view": true,
"companies_manage": true,
"contacts_view": true,
"contacts_manage": true,
"team_members_contact_info_view": true,
"cost_rates_view": true,
"cost_rates_view_inside_subsidiary": true,
"cost_rates_manage": true,
"cost_rates_view_for_subordinates": true,
"custom_fields_manage": true,
"task_custom_fields_manage": true,
"doc_custom_fields_manage": true,
"deals_view_restricted": true,
"deals_view_all": true,
"deals_manage": true,
"deals_share": true,
"deals_scenarios_view": true,
"deals_scenarios_manage": true,
"deals_scenarios_apply": true,
"deals_proposals_delete_signed": true,
"deals_funnel_reports_view": true,
"document_types_and_styles_manage": true,
"docs_manage": true,
"docs_view": true,
"emails_manage": true,
"entitlements_view_self": true,
"entitlements_view_all": true,
"entitlements_manage": true,
"entitlements_view_inside_subsidiary": true,
"events_view": true,
"events_manage": true,
"expenses_view_self": true,
"expenses_view_all": true,
"expenses_view_restricted": true,
"expenses_manage_self": true,
"expenses_manage": true,
"expenses_approve_where_deal_owner": true,
"expenses_approve_restricted": true,
"expenses_approve_all": true,
"financials_locking_manage": true,
"financial_item_reports_view": true,
"holidays_manage": true,
"imports_manage": true,
"integrations_manage_organizational": true,
"integrations_manage_personal": true,
"integrations_manage_task_management": true,
"integrations_view_task_management": true,
"invoices_view_restricted": true,
"invoices_view_all": true,
"invoices_manage_draft": true,
"invoices_manage_finalized": true,
"invoices_limited_manage_finalized": true,
"invoices_copy_to_accounting": true,
"invoices_manage_intercompany": true,
"invoices_send_to_client": true,
"organization_administrate": true,
"organization_polaris_access": true,
"overheads_manage": true,
"payments_view": true,
"payments_manage": true,
"payment_reminders_manage": true,
"payment_reminder_sequences_manage": true,
"placeholders_view": true,
"placeholders_manage": true,
"profitability_view": true,
"projects_view_restricted": true,
"projects_view_all": true,
"projects_manage": true,
"boards_manage": true,
"task_lists_manage": true,
"purchase_orders_view_restricted": true,
"purchase_orders_manage": true,
"resource_requests_view": true,
"resource_requests_create": true,
"resource_requests_resolve": true,
"rate_cards_view": true,
"rate_cards_manage": true,
"report_categories_manage": true,
"insights_view": true,
"insights_manage": true,
"roles_view": true,
"roles_manage": true,
"sales_manage": true,
"service_bookings_view_self": true,
"service_bookings_view_restricted": true,
"service_bookings_view_all": true,
"service_bookings_manage": true,
"service_bookings_view_tentative": true,
"service_types_view": true,
"service_types_manage": true,
"subscription_manage_billing": true,
"subscription_manage_seats": true,
"subscription_manage": true,
"surveys_manage": true,
"tasks_view": true,
"tasks_manage": true,
"tax_rates_manage": true,
"teams_view": true,
"teams_manage": true,
"time_entries_view_all": true,
"time_entries_view_restricted": true,
"time_entries_manage": true,
"time_entries_manage_self": true,
"time_entries_manage_locked": true,
"time_entries_approve_restricted": true,
"time_entries_approve_where_user_is_approver": true,
"time_entries_approve_all": true,
"time_off_bookings_view_all": true,
"time_off_bookings_manage_self": true,
"time_off_bookings_manage_all": true,
"time_off_bookings_approve_all": true,
"time_off_bookings_approve_restricted": true,
"time_off_bookings_view_note": true,
"time_off_bookings_view_inside_subsidiary": true,
"time_reports_view_self": true,
"time_reports_view_all": true,
"time_tracking_policies_manage": true,
"team_members_and_roles_view": true,
"team_members_manage": true,
"team_members_roles_manage": true,
"clients_view": true,
"clients_manage": true,
"contacts_custom_field_values_view": true,
"contacts_custom_field_values_manage": true,
"contacts_sensitive_custom_field_values_view": true,
"contacts_sensitive_custom_field_values_manage": true,
"employees_field_values_view": true,
"employees_field_values_manage": true,
"employees_sensitive_custom_field_values_view": true,
"employees_sensitive_custom_field_values_manage": true,
"clients_deactivation_and_offboarding_manage": true,
"team_members_deactivation_and_offboarding_manage": true,
"webhooks_manage_webhooks": true,
"webhooks_manage_own_zapier_triggers": true,
"workflows_manage": true,
"workload_items_view": true
}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2496"
}
}
}
},
{
"id": "6820",
"type": "companies",
"attributes": {
"name": "Organization2497",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2025-12-26T05:20:32.220+01:00",
"last_activity_at": "2025-12-26T05:20:32.220+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "ORGA",
"domain": null,
"projectless_budgets": false,
"leitweg_id": null,
"buyer_reference": null,
"peppol_id": null,
"default_subsidiary_id": null,
"default_tax_rate_id": null,
"default_document_type_id": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false,
"settings": {},
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2496"
}
},
"default_subsidiary": {
"meta": {
"included": false
}
},
"default_tax_rate": {
"meta": {
"included": false
}
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"integration_exporter_configuration": {
"meta": {
"included": false
}
},
"einvoice_identity": {
"meta": {
"included": false
}
}
}
},
{
"id": "9502",
"type": "roles",
"attributes": {
"base_role_id": 3,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1,
"resolved_permissions": {
"allocations_view": false,
"automations_manage": false,
"bank_accounts_manage": false,
"billables_view": false,
"budgets_view_restricted": false,
"budgets_view_all": false,
"budgets_manage": false,
"budgets_share": false,
"budgets_scenarios_view": false,
"budgets_scenarios_manage": false,
"budgets_scenarios_apply": false,
"companies_view": false,
"companies_manage": false,
"contacts_view": false,
"contacts_manage": false,
"team_members_contact_info_view": true,
"cost_rates_view": false,
"cost_rates_view_inside_subsidiary": false,
"cost_rates_manage": false,
"cost_rates_view_for_subordinates": false,
"custom_fields_manage": false,
"task_custom_fields_manage": false,
"doc_custom_fields_manage": false,
"deals_view_restricted": false,
"deals_view_all": false,
"deals_manage": false,
"deals_share": false,
"deals_scenarios_view": false,
"deals_scenarios_manage": false,
"deals_scenarios_apply": false,
"deals_proposals_delete_signed": false,
"deals_funnel_reports_view": false,
"document_types_and_styles_manage": false,
"docs_manage": true,
"docs_view": true,
"emails_manage": false,
"entitlements_view_self": true,
"entitlements_view_all": false,
"entitlements_manage": false,
"entitlements_view_inside_subsidiary": false,
"events_view": true,
"events_manage": false,
"expenses_view_self": true,
"expenses_view_all": false,
"expenses_view_restricted": false,
"expenses_manage_self": true,
"expenses_manage": false,
"expenses_approve_where_deal_owner": false,
"expenses_approve_restricted": false,
"expenses_approve_all": false,
"financials_locking_manage": false,
"financial_item_reports_view": false,
"holidays_manage": false,
"imports_manage": false,
"integrations_manage_organizational": false,
"integrations_manage_personal": true,
"integrations_manage_task_management": false,
"integrations_view_task_management": true,
"invoices_view_restricted": false,
"invoices_view_all": false,
"invoices_manage_draft": false,
"invoices_manage_finalized": false,
"invoices_limited_manage_finalized": false,
"invoices_copy_to_accounting": false,
"invoices_manage_intercompany": false,
"invoices_send_to_client": false,
"organization_administrate": false,
"organization_polaris_access": false,
"overheads_manage": false,
"payments_view": false,
"payments_manage": false,
"payment_reminders_manage": false,
"payment_reminder_sequences_manage": false,
"placeholders_view": false,
"placeholders_manage": false,
"profitability_view": false,
"projects_view_restricted": true,
"projects_view_all": false,
"projects_manage": false,
"boards_manage": false,
"task_lists_manage": true,
"purchase_orders_view_restricted": false,
"purchase_orders_manage": false,
"resource_requests_view": false,
"resource_requests_create": false,
"resource_requests_resolve": false,
"rate_cards_view": false,
"rate_cards_manage": false,
"report_categories_manage": false,
"insights_view": false,
"insights_manage": false,
"roles_view": false,
"roles_manage": false,
"sales_manage": false,
"service_bookings_view_self": true,
"service_bookings_view_restricted": false,
"service_bookings_view_all": false,
"service_bookings_manage": false,
"service_bookings_view_tentative": false,
"service_types_view": true,
"service_types_manage": false,
"subscription_manage_billing": false,
"subscription_manage_seats": false,
"subscription_manage": false,
"surveys_manage": false,
"tasks_view": true,
"tasks_manage": true,
"tax_rates_manage": false,
"teams_view": true,
"teams_manage": false,
"time_entries_view_all": false,
"time_entries_view_restricted": false,
"time_entries_manage": false,
"time_entries_manage_self": true,
"time_entries_manage_locked": false,
"time_entries_approve_restricted": false,
"time_entries_approve_where_user_is_approver": false,
"time_entries_approve_all": false,
"time_off_bookings_view_all": false,
"time_off_bookings_manage_self": true,
"time_off_bookings_manage_all": false,
"time_off_bookings_approve_all": false,
"time_off_bookings_approve_restricted": false,
"time_off_bookings_view_note": false,
"time_off_bookings_view_inside_subsidiary": false,
"time_reports_view_self": true,
"time_reports_view_all": false,
"time_tracking_policies_manage": false,
"team_members_and_roles_view": false,
"team_members_manage": false,
"team_members_roles_manage": false,
"clients_view": false,
"clients_manage": false,
"contacts_custom_field_values_view": false,
"contacts_custom_field_values_manage": false,
"contacts_sensitive_custom_field_values_view": false,
"contacts_sensitive_custom_field_values_manage": false,
"employees_field_values_view": true,
"employees_field_values_manage": false,
"employees_sensitive_custom_field_values_view": false,
"employees_sensitive_custom_field_values_manage": false,
"clients_deactivation_and_offboarding_manage": false,
"team_members_deactivation_and_offboarding_manage": false,
"webhooks_manage_webhooks": false,
"webhooks_manage_own_zapier_triggers": false,
"workflows_manage": false,
"workload_items_view": true
}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2496"
}
}
}
},
{
"id": "2903",
"type": "workflow_statuses",
"attributes": {
"name": "Closed",
"color_id": "1",
"position": 1,
"category_id": 3
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2496"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2333"
}
}
}
}
],
"meta": {}
}PATCHÂ Â /api/v2/survey_fields/43
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "survey_fields",
"attributes": {
"name": null
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
}
]
}Updates a survey fieldPATCH/api/v2/survey_fields/{id}
URI Parameters
- id
number(required) Example: 1survey field id
PATCH /api/v2/survey_fields/1/archive
Requests
PATCHÂ Â /api/v2/survey_fields/44/archive
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "44",
"type": "survey_fields",
"attributes": {
"created_at": "2025-12-26T05:20:32.518+01:00",
"updated_at": "2025-12-26T05:20:32.544+01:00",
"name": "Custom field no.36",
"data_type_id": 3,
"required": false,
"description": null,
"archived_at": "2025-12-26T05:20:32.000+01:00",
"aggregation_type_id": null,
"formatting_type_id": null,
"global": null,
"show_in_add_edit_views": true,
"sensitive": false,
"position": 1,
"quick_add_enabled": false,
"customizable_type": "survey_responses"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2498"
}
},
"survey": {
"data": {
"type": "surveys",
"id": "25"
}
},
"origin_field": {
"data": null
},
"options": {
"data": [
{
"type": "survey_field_options",
"id": "18"
},
{
"type": "survey_field_options",
"id": "19"
},
{
"type": "survey_field_options",
"id": "20"
}
]
},
"custom_field_people": {
"data": []
}
}
},
"included": [
{
"id": "25",
"type": "surveys",
"attributes": {
"title": "Survey22",
"description": null,
"public_uuid": "e360828e-9189-500d-a046-29a666d24a91",
"submission_access": "nobody",
"created_at": "2025-12-26T05:20:32.512+01:00",
"updated_at": "2025-12-26T05:20:32.545+01:00"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2498"
}
},
"project": {
"data": {
"type": "projects",
"id": "1876"
}
},
"creator": {
"data": {
"type": "people",
"id": "9238"
}
},
"updater": {
"data": {
"type": "people",
"id": "9238"
}
}
}
},
{
"id": "18",
"type": "survey_field_options",
"attributes": {
"name": "High",
"archived_at": "2025-12-26T05:20:32.000+01:00",
"position": 1,
"color_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2498"
}
},
"survey_field": {
"meta": {
"included": false
}
}
}
},
{
"id": "19",
"type": "survey_field_options",
"attributes": {
"name": "High",
"archived_at": "2025-12-26T05:20:32.000+01:00",
"position": 1,
"color_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2498"
}
},
"survey_field": {
"meta": {
"included": false
}
}
}
},
{
"id": "20",
"type": "survey_field_options",
"attributes": {
"name": "High",
"archived_at": "2025-12-26T05:20:32.000+01:00",
"position": 1,
"color_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2498"
}
},
"survey_field": {
"meta": {
"included": false
}
}
}
},
{
"id": "1876",
"type": "projects",
"attributes": {
"name": "test project",
"number": "1",
"preferences": {},
"project_number": "1",
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": "2025-12-26T05:20:32.000+01:00",
"tag_colors": {},
"archived_at": null,
"created_at": "2025-12-26T05:20:32.500+01:00",
"template": false,
"duplication_status": "idle",
"custom_fields": null,
"task_custom_fields_ids": null,
"task_custom_fields_positions": null,
"page_custom_fields_ids": null,
"page_custom_fields_positions": null,
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2498"
}
},
"company": {
"data": {
"type": "companies",
"id": "6825"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "9239"
}
},
"last_actor": {
"data": {
"type": "people",
"id": "9238"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2335"
}
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"template_object": {
"data": null
}
}
},
{
"id": "9238",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user9085@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": 1,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": null,
"is_user": true,
"user_id": 9163,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-12-26T05:20:32.466+01:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": null,
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 1,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2498"
}
},
"manager": {
"data": null
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "9505"
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"data": []
},
"service_types": {
"data": []
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
{
"id": "6825",
"type": "companies",
"attributes": {
"name": "Client4409",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2025-12-26T05:20:32.496+01:00",
"last_activity_at": "2025-12-26T05:20:32.496+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "CLIE4413",
"domain": null,
"projectless_budgets": false,
"leitweg_id": null,
"buyer_reference": null,
"peppol_id": null,
"default_subsidiary_id": null,
"default_tax_rate_id": null,
"default_document_type_id": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false,
"settings": {},
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2498"
}
},
"default_subsidiary": {
"meta": {
"included": false
}
},
"default_tax_rate": {
"meta": {
"included": false
}
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"integration_exporter_configuration": {
"meta": {
"included": false
}
},
"einvoice_identity": {
"meta": {
"included": false
}
}
}
},
{
"id": "9239",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user9086@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": 3,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": "2025-12-26T05:20:00.000+01:00",
"is_user": true,
"user_id": 9164,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-12-26T05:20:32.485+01:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-12-26T05:20:32.485+01:00",
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 1,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2498"
}
},
"manager": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "6824"
}
},
"subsidiary": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "9506"
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"data": []
},
"service_types": {
"data": []
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
{
"id": "2335",
"type": "workflows",
"attributes": {
"name": "Simple workflow",
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2498"
}
},
"workflow_statuses": {
"data": [
{
"type": "workflow_statuses",
"id": "2905"
}
]
}
}
},
{
"id": "9505",
"type": "roles",
"attributes": {
"base_role_id": 1,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1,
"resolved_permissions": {
"allocations_view": false,
"automations_manage": true,
"bank_accounts_manage": true,
"billables_view": true,
"budgets_view_restricted": true,
"budgets_view_all": true,
"budgets_manage": true,
"budgets_share": true,
"budgets_scenarios_view": true,
"budgets_scenarios_manage": true,
"budgets_scenarios_apply": true,
"companies_view": true,
"companies_manage": true,
"contacts_view": true,
"contacts_manage": true,
"team_members_contact_info_view": true,
"cost_rates_view": true,
"cost_rates_view_inside_subsidiary": true,
"cost_rates_manage": true,
"cost_rates_view_for_subordinates": true,
"custom_fields_manage": true,
"task_custom_fields_manage": true,
"doc_custom_fields_manage": true,
"deals_view_restricted": true,
"deals_view_all": true,
"deals_manage": true,
"deals_share": true,
"deals_scenarios_view": true,
"deals_scenarios_manage": true,
"deals_scenarios_apply": true,
"deals_proposals_delete_signed": true,
"deals_funnel_reports_view": true,
"document_types_and_styles_manage": true,
"docs_manage": true,
"docs_view": true,
"emails_manage": true,
"entitlements_view_self": true,
"entitlements_view_all": true,
"entitlements_manage": true,
"entitlements_view_inside_subsidiary": true,
"events_view": true,
"events_manage": true,
"expenses_view_self": true,
"expenses_view_all": true,
"expenses_view_restricted": true,
"expenses_manage_self": true,
"expenses_manage": true,
"expenses_approve_where_deal_owner": true,
"expenses_approve_restricted": true,
"expenses_approve_all": true,
"financials_locking_manage": true,
"financial_item_reports_view": true,
"holidays_manage": true,
"imports_manage": true,
"integrations_manage_organizational": true,
"integrations_manage_personal": true,
"integrations_manage_task_management": true,
"integrations_view_task_management": true,
"invoices_view_restricted": true,
"invoices_view_all": true,
"invoices_manage_draft": true,
"invoices_manage_finalized": true,
"invoices_limited_manage_finalized": true,
"invoices_copy_to_accounting": true,
"invoices_manage_intercompany": true,
"invoices_send_to_client": true,
"organization_administrate": true,
"organization_polaris_access": true,
"overheads_manage": true,
"payments_view": true,
"payments_manage": true,
"payment_reminders_manage": true,
"payment_reminder_sequences_manage": true,
"placeholders_view": true,
"placeholders_manage": true,
"profitability_view": true,
"projects_view_restricted": true,
"projects_view_all": true,
"projects_manage": true,
"boards_manage": true,
"task_lists_manage": true,
"purchase_orders_view_restricted": true,
"purchase_orders_manage": true,
"resource_requests_view": true,
"resource_requests_create": true,
"resource_requests_resolve": true,
"rate_cards_view": true,
"rate_cards_manage": true,
"report_categories_manage": true,
"insights_view": true,
"insights_manage": true,
"roles_view": true,
"roles_manage": true,
"sales_manage": true,
"service_bookings_view_self": true,
"service_bookings_view_restricted": true,
"service_bookings_view_all": true,
"service_bookings_manage": true,
"service_bookings_view_tentative": true,
"service_types_view": true,
"service_types_manage": true,
"subscription_manage_billing": true,
"subscription_manage_seats": true,
"subscription_manage": true,
"surveys_manage": true,
"tasks_view": true,
"tasks_manage": true,
"tax_rates_manage": true,
"teams_view": true,
"teams_manage": true,
"time_entries_view_all": true,
"time_entries_view_restricted": true,
"time_entries_manage": true,
"time_entries_manage_self": true,
"time_entries_manage_locked": true,
"time_entries_approve_restricted": true,
"time_entries_approve_where_user_is_approver": true,
"time_entries_approve_all": true,
"time_off_bookings_view_all": true,
"time_off_bookings_manage_self": true,
"time_off_bookings_manage_all": true,
"time_off_bookings_approve_all": true,
"time_off_bookings_approve_restricted": true,
"time_off_bookings_view_note": true,
"time_off_bookings_view_inside_subsidiary": true,
"time_reports_view_self": true,
"time_reports_view_all": true,
"time_tracking_policies_manage": true,
"team_members_and_roles_view": true,
"team_members_manage": true,
"team_members_roles_manage": true,
"clients_view": true,
"clients_manage": true,
"contacts_custom_field_values_view": true,
"contacts_custom_field_values_manage": true,
"contacts_sensitive_custom_field_values_view": true,
"contacts_sensitive_custom_field_values_manage": true,
"employees_field_values_view": true,
"employees_field_values_manage": true,
"employees_sensitive_custom_field_values_view": true,
"employees_sensitive_custom_field_values_manage": true,
"clients_deactivation_and_offboarding_manage": true,
"team_members_deactivation_and_offboarding_manage": true,
"webhooks_manage_webhooks": true,
"webhooks_manage_own_zapier_triggers": true,
"workflows_manage": true,
"workload_items_view": true
}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2498"
}
}
}
},
{
"id": "6824",
"type": "companies",
"attributes": {
"name": "Organization2499",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2025-12-26T05:20:32.473+01:00",
"last_activity_at": "2025-12-26T05:20:32.473+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "ORGA",
"domain": null,
"projectless_budgets": false,
"leitweg_id": null,
"buyer_reference": null,
"peppol_id": null,
"default_subsidiary_id": null,
"default_tax_rate_id": null,
"default_document_type_id": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false,
"settings": {},
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2498"
}
},
"default_subsidiary": {
"meta": {
"included": false
}
},
"default_tax_rate": {
"meta": {
"included": false
}
},
"custom_field_people": {
"data": []
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"integration_exporter_configuration": {
"meta": {
"included": false
}
},
"einvoice_identity": {
"meta": {
"included": false
}
}
}
},
{
"id": "9506",
"type": "roles",
"attributes": {
"base_role_id": 3,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1,
"resolved_permissions": {
"allocations_view": false,
"automations_manage": false,
"bank_accounts_manage": false,
"billables_view": false,
"budgets_view_restricted": false,
"budgets_view_all": false,
"budgets_manage": false,
"budgets_share": false,
"budgets_scenarios_view": false,
"budgets_scenarios_manage": false,
"budgets_scenarios_apply": false,
"companies_view": false,
"companies_manage": false,
"contacts_view": false,
"contacts_manage": false,
"team_members_contact_info_view": true,
"cost_rates_view": false,
"cost_rates_view_inside_subsidiary": false,
"cost_rates_manage": false,
"cost_rates_view_for_subordinates": false,
"custom_fields_manage": false,
"task_custom_fields_manage": false,
"doc_custom_fields_manage": false,
"deals_view_restricted": false,
"deals_view_all": false,
"deals_manage": false,
"deals_share": false,
"deals_scenarios_view": false,
"deals_scenarios_manage": false,
"deals_scenarios_apply": false,
"deals_proposals_delete_signed": false,
"deals_funnel_reports_view": false,
"document_types_and_styles_manage": false,
"docs_manage": true,
"docs_view": true,
"emails_manage": false,
"entitlements_view_self": true,
"entitlements_view_all": false,
"entitlements_manage": false,
"entitlements_view_inside_subsidiary": false,
"events_view": true,
"events_manage": false,
"expenses_view_self": true,
"expenses_view_all": false,
"expenses_view_restricted": false,
"expenses_manage_self": true,
"expenses_manage": false,
"expenses_approve_where_deal_owner": false,
"expenses_approve_restricted": false,
"expenses_approve_all": false,
"financials_locking_manage": false,
"financial_item_reports_view": false,
"holidays_manage": false,
"imports_manage": false,
"integrations_manage_organizational": false,
"integrations_manage_personal": true,
"integrations_manage_task_management": false,
"integrations_view_task_management": true,
"invoices_view_restricted": false,
"invoices_view_all": false,
"invoices_manage_draft": false,
"invoices_manage_finalized": false,
"invoices_limited_manage_finalized": false,
"invoices_copy_to_accounting": false,
"invoices_manage_intercompany": false,
"invoices_send_to_client": false,
"organization_administrate": false,
"organization_polaris_access": false,
"overheads_manage": false,
"payments_view": false,
"payments_manage": false,
"payment_reminders_manage": false,
"payment_reminder_sequences_manage": false,
"placeholders_view": false,
"placeholders_manage": false,
"profitability_view": false,
"projects_view_restricted": true,
"projects_view_all": false,
"projects_manage": false,
"boards_manage": false,
"task_lists_manage": true,
"purchase_orders_view_restricted": false,
"purchase_orders_manage": false,
"resource_requests_view": false,
"resource_requests_create": false,
"resource_requests_resolve": false,
"rate_cards_view": false,
"rate_cards_manage": false,
"report_categories_manage": false,
"insights_view": false,
"insights_manage": false,
"roles_view": false,
"roles_manage": false,
"sales_manage": false,
"service_bookings_view_self": true,
"service_bookings_view_restricted": false,
"service_bookings_view_all": false,
"service_bookings_manage": false,
"service_bookings_view_tentative": false,
"service_types_view": true,
"service_types_manage": false,
"subscription_manage_billing": false,
"subscription_manage_seats": false,
"subscription_manage": false,
"surveys_manage": false,
"tasks_view": true,
"tasks_manage": true,
"tax_rates_manage": false,
"teams_view": true,
"teams_manage": false,
"time_entries_view_all": false,
"time_entries_view_restricted": false,
"time_entries_manage": false,
"time_entries_manage_self": true,
"time_entries_manage_locked": false,
"time_entries_approve_restricted": false,
"time_entries_approve_where_user_is_approver": false,
"time_entries_approve_all": false,
"time_off_bookings_view_all": false,
"time_off_bookings_manage_self": true,
"time_off_bookings_manage_all": false,
"time_off_bookings_approve_all": false,
"time_off_bookings_approve_restricted": false,
"time_off_bookings_view_note": false,
"time_off_bookings_view_inside_subsidiary": false,
"time_reports_view_self": true,
"time_reports_view_all": false,
"time_tracking_policies_manage": false,
"team_members_and_roles_view": false,
"team_members_manage": false,
"team_members_roles_manage": false,
"clients_view": false,
"clients_manage": false,
"contacts_custom_field_values_view": false,
"contacts_custom_field_values_manage": false,
"contacts_sensitive_custom_field_values_view": false,
"contacts_sensitive_custom_field_values_manage": false,
"employees_field_values_view": true,
"employees_field_values_manage": false,
"employees_sensitive_custom_field_values_view": false,
"employees_sensitive_custom_field_values_manage": false,
"clients_deactivation_and_offboarding_manage": false,
"team_members_deactivation_and_offboarding_manage": false,
"webhooks_manage_webhooks": false,
"webhooks_manage_own_zapier_triggers": false,
"workflows_manage": false,
"workload_items_view": true
}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2498"
}
}
}
},
{
"id": "2905",
"type": "workflow_statuses",
"attributes": {
"name": "Closed",
"color_id": "1",
"position": 1,
"category_id": 3
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2498"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2335"
}
}
}
}
],
"meta": {}
}Archives a survey fieldPATCH/api/v2/survey_fields/{id}/archive
URI Parameters
- id
number(required) Example: 1survey field id
Generated by aglio on 26 Dec 2025