API Documentation

API Endpoint

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
Requestsreturns survey_fields

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+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "35",
      "type": "survey_fields",
      "attributes": {
        "created_at": "2025-10-25T06:23:58.366+02:00",
        "updated_at": "2025-10-25T06:23:58.366+02:00",
        "name": "Custom field no.32",
        "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": "2419"
          }
        },
        "survey": {
          "data": {
            "type": "surveys",
            "id": "18"
          }
        },
        "origin_field": {
          "data": null
        },
        "options": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    }
  ],
  "included": [
    {
      "id": "18",
      "type": "surveys",
      "attributes": {
        "title": "Survey15",
        "description": null,
        "public_uuid": "9ce313fd-f024-58d4-a3f1-27434713917f",
        "submission_access": "nobody",
        "created_at": "2025-10-25T06:23:58.360+02:00",
        "updated_at": "2025-10-25T06:23:58.367+02:00"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2419"
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "1856"
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "9057"
          }
        },
        "updater": {
          "data": {
            "type": "people",
            "id": "9057"
          }
        }
      }
    },
    {
      "id": "1856",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": "1",
        "preferences": {},
        "project_number": "1",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": "2025-10-25T06:23:58.000+02:00",
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2025-10-25T06:23:58.345+02: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": "2419"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "6654"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "9058"
          }
        },
        "last_actor": {
          "data": {
            "type": "people",
            "id": "9057"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2314"
          }
        },
        "custom_field_people": {
          "data": []
        },
        "custom_field_attachments": {
          "meta": {
            "included": false
          }
        },
        "template_object": {
          "data": null
        }
      }
    },
    {
      "id": "9057",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "contact": {},
        "deactivated_at": null,
        "email": "user8940@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": 9018,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "created_at": "2025-10-25T06:23:58.305+02: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": "2419"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "9360"
          }
        },
        "approval_policy_assignment": {
          "meta": {
            "included": false
          }
        },
        "teams": {
          "data": []
        },
        "service_types": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        },
        "custom_field_attachments": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "6654",
      "type": "companies",
      "attributes": {
        "name": "Client4312",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2025-10-25T06:23:58.341+02:00",
        "last_activity_at": "2025-10-25T06:23:58.341+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "CLIE4316",
        "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": "2419"
          }
        },
        "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
          }
        }
      }
    },
    {
      "id": "9058",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "contact": {},
        "deactivated_at": null,
        "email": "user8941@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-10-25T06:23:00.000+02:00",
        "is_user": true,
        "user_id": 9019,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "created_at": "2025-10-25T06:23:58.328+02: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-10-25T06:23:58.328+02: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": "2419"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "6653"
          }
        },
        "subsidiary": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "9361"
          }
        },
        "approval_policy_assignment": {
          "meta": {
            "included": false
          }
        },
        "teams": {
          "data": []
        },
        "service_types": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        },
        "custom_field_attachments": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "2314",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2419"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "2951"
            }
          ]
        }
      }
    },
    {
      "id": "9360",
      "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
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2419"
          }
        }
      }
    },
    {
      "id": "6653",
      "type": "companies",
      "attributes": {
        "name": "Organization2420",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2025-10-25T06:23:58.314+02:00",
        "last_activity_at": "2025-10-25T06:23:58.314+02: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": "2419"
          }
        },
        "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
          }
        }
      }
    },
    {
      "id": "9361",
      "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
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2419"
          }
        }
      }
    },
    {
      "id": "2951",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Closed",
        "color_id": "1",
        "position": 1,
        "category_id": 3
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2419"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2314"
          }
        }
      }
    }
  ],
  "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 fields
GET/api/v2/survey_fields

GET /api/v2/survey_fields/1
Requestsreturns survey_field

GET  /api/v2/survey_fields/37

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+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "37",
    "type": "survey_fields",
    "attributes": {
      "created_at": "2025-10-25T06:23:58.515+02:00",
      "updated_at": "2025-10-25T06:23:58.515+02:00",
      "name": "Custom field no.34",
      "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": "2420"
        }
      },
      "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-10-25T06:23:58.509+02:00",
        "updated_at": "2025-10-25T06:23:58.516+02:00"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2420"
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "1857"
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "9059"
          }
        },
        "updater": {
          "data": {
            "type": "people",
            "id": "9059"
          }
        }
      }
    },
    {
      "id": "1857",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": "1",
        "preferences": {},
        "project_number": "1",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": "2025-10-25T06:23:58.000+02:00",
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2025-10-25T06:23:58.496+02: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": "2420"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "6656"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "9060"
          }
        },
        "last_actor": {
          "data": {
            "type": "people",
            "id": "9059"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2315"
          }
        },
        "custom_field_people": {
          "data": []
        },
        "custom_field_attachments": {
          "meta": {
            "included": false
          }
        },
        "template_object": {
          "data": null
        }
      }
    },
    {
      "id": "9059",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "contact": {},
        "deactivated_at": null,
        "email": "user8942@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": 9020,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "created_at": "2025-10-25T06:23:58.457+02: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": "2420"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "9362"
          }
        },
        "approval_policy_assignment": {
          "meta": {
            "included": false
          }
        },
        "teams": {
          "data": []
        },
        "service_types": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        },
        "custom_field_attachments": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "6656",
      "type": "companies",
      "attributes": {
        "name": "Client4313",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2025-10-25T06:23:58.492+02:00",
        "last_activity_at": "2025-10-25T06:23:58.492+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "CLIE4317",
        "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": "2420"
          }
        },
        "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
          }
        }
      }
    },
    {
      "id": "9060",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "contact": {},
        "deactivated_at": null,
        "email": "user8943@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-10-25T06:23:00.000+02:00",
        "is_user": true,
        "user_id": 9021,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "created_at": "2025-10-25T06:23:58.480+02: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-10-25T06:23:58.480+02: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": "2420"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "6655"
          }
        },
        "subsidiary": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "9363"
          }
        },
        "approval_policy_assignment": {
          "meta": {
            "included": false
          }
        },
        "teams": {
          "data": []
        },
        "service_types": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        },
        "custom_field_attachments": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "2315",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2420"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "2952"
            }
          ]
        }
      }
    },
    {
      "id": "9362",
      "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
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2420"
          }
        }
      }
    },
    {
      "id": "6655",
      "type": "companies",
      "attributes": {
        "name": "Organization2421",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2025-10-25T06:23:58.466+02:00",
        "last_activity_at": "2025-10-25T06:23:58.466+02: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": "2420"
          }
        },
        "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
          }
        }
      }
    },
    {
      "id": "9363",
      "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
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2420"
          }
        }
      }
    },
    {
      "id": "2952",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Closed",
        "color_id": "1",
        "position": 1,
        "category_id": 3
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2420"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2315"
          }
        }
      }
    }
  ],
  "meta": {}
}

Gets a survey field
GET/api/v2/survey_fields/{id}

URI Parameters
HideShow
id
number (required) Example: 1

survey field id

POST /api/v2/survey_fields
Requestscreates survey field when params validreturns errors when params invalid

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+json
Body
{
  "data": {
    "type": "survey_fields",
    "attributes": {
      "name": "Just an another question for survey",
      "survey_id": 20,
      "customizable_type": "survey_responses",
      "data_type_id": 1
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "38",
    "type": "survey_fields",
    "attributes": {
      "created_at": "2025-10-25T06:23:58.668+02:00",
      "updated_at": "2025-10-25T06:23:58.668+02: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": "2421"
        }
      },
      "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-10-25T06:23:58.645+02:00",
        "updated_at": "2025-10-25T06:23:58.670+02:00"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2421"
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "1858"
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "9061"
          }
        },
        "updater": {
          "data": {
            "type": "people",
            "id": "9061"
          }
        }
      }
    },
    {
      "id": "1858",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": "1",
        "preferences": {},
        "project_number": "1",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": "2025-10-25T06:23:58.000+02:00",
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2025-10-25T06:23:58.632+02: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": "2421"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "6658"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "9062"
          }
        },
        "last_actor": {
          "data": {
            "type": "people",
            "id": "9061"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2316"
          }
        },
        "custom_field_people": {
          "data": []
        },
        "custom_field_attachments": {
          "meta": {
            "included": false
          }
        },
        "template_object": {
          "data": null
        }
      }
    },
    {
      "id": "9061",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "contact": {},
        "deactivated_at": null,
        "email": "user8944@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": 9022,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "created_at": "2025-10-25T06:23:58.590+02: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": "2421"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "9364"
          }
        },
        "approval_policy_assignment": {
          "meta": {
            "included": false
          }
        },
        "teams": {
          "data": []
        },
        "service_types": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        },
        "custom_field_attachments": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "6658",
      "type": "companies",
      "attributes": {
        "name": "Client4314",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2025-10-25T06:23:58.627+02:00",
        "last_activity_at": "2025-10-25T06:23:58.627+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "CLIE4318",
        "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": "2421"
          }
        },
        "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
          }
        }
      }
    },
    {
      "id": "9062",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "contact": {},
        "deactivated_at": null,
        "email": "user8945@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-10-25T06:23:00.000+02:00",
        "is_user": true,
        "user_id": 9023,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "created_at": "2025-10-25T06:23:58.614+02: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-10-25T06:23:58.614+02: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": "2421"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "6657"
          }
        },
        "subsidiary": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "9365"
          }
        },
        "approval_policy_assignment": {
          "meta": {
            "included": false
          }
        },
        "teams": {
          "data": []
        },
        "service_types": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        },
        "custom_field_attachments": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "2316",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2421"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "2953"
            }
          ]
        }
      }
    },
    {
      "id": "9364",
      "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
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2421"
          }
        }
      }
    },
    {
      "id": "6657",
      "type": "companies",
      "attributes": {
        "name": "Organization2422",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2025-10-25T06:23:58.600+02:00",
        "last_activity_at": "2025-10-25T06:23:58.600+02: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": "2421"
          }
        },
        "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
          }
        }
      }
    },
    {
      "id": "9365",
      "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
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2421"
          }
        }
      }
    },
    {
      "id": "2953",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Closed",
        "color_id": "1",
        "position": 1,
        "category_id": 3
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2421"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2316"
          }
        }
      }
    }
  ],
  "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+json
Body
{
  "data": {
    "type": "survey_fields",
    "attributes": {
      "name": "Just an another question for survey",
      "survey_id": 21,
      "customizable_type": "survey_responses",
      "data_type_id": null
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "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 field
POST/api/v2/survey_fields

URI Parameters
HideShow
survey_id
number (required) Example: 1

survey id

data_type_id
number (required) Example: 1

data type id

name
string (required) Example: Survey+Field+name

survey field name

origin_field_id
number (optional) Example: 1

origin field id

PATCH /api/v2/survey_fields/1
Requestsupdates survey field when validreturns error

PATCH  /api/v2/survey_fields/39

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+json
Body
{
  "data": {
    "type": "survey_fields",
    "attributes": {
      "name": "New name"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "39",
    "type": "survey_fields",
    "attributes": {
      "created_at": "2025-10-25T06:23:58.909+02:00",
      "updated_at": "2025-10-25T06:23:58.924+02: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": "2423"
        }
      },
      "survey": {
        "data": {
          "type": "surveys",
          "id": "22"
        }
      },
      "origin_field": {
        "data": null
      },
      "options": {
        "data": []
      },
      "custom_field_people": {
        "data": []
      }
    }
  },
  "included": [
    {
      "id": "22",
      "type": "surveys",
      "attributes": {
        "title": "Survey19",
        "description": null,
        "public_uuid": "fe19ee27-a03c-5b10-991e-8eea707cf15d",
        "submission_access": "nobody",
        "created_at": "2025-10-25T06:23:58.903+02:00",
        "updated_at": "2025-10-25T06:23:58.925+02:00"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2423"
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "1860"
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "9065"
          }
        },
        "updater": {
          "data": {
            "type": "people",
            "id": "9065"
          }
        }
      }
    },
    {
      "id": "1860",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": "1",
        "preferences": {},
        "project_number": "1",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": "2025-10-25T06:23:58.000+02:00",
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2025-10-25T06:23:58.889+02: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": "2423"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "6662"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "9066"
          }
        },
        "last_actor": {
          "data": {
            "type": "people",
            "id": "9065"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2318"
          }
        },
        "custom_field_people": {
          "data": []
        },
        "custom_field_attachments": {
          "meta": {
            "included": false
          }
        },
        "template_object": {
          "data": null
        }
      }
    },
    {
      "id": "9065",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "contact": {},
        "deactivated_at": null,
        "email": "user8948@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": 9026,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "created_at": "2025-10-25T06:23:58.850+02: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": "2423"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "9368"
          }
        },
        "approval_policy_assignment": {
          "meta": {
            "included": false
          }
        },
        "teams": {
          "data": []
        },
        "service_types": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        },
        "custom_field_attachments": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "6662",
      "type": "companies",
      "attributes": {
        "name": "Client4316",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2025-10-25T06:23:58.885+02:00",
        "last_activity_at": "2025-10-25T06:23:58.885+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "CLIE4320",
        "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": "2423"
          }
        },
        "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
          }
        }
      }
    },
    {
      "id": "9066",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "contact": {},
        "deactivated_at": null,
        "email": "user8949@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-10-25T06:23:00.000+02:00",
        "is_user": true,
        "user_id": 9027,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "created_at": "2025-10-25T06:23:58.872+02: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-10-25T06:23:58.872+02: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": "2423"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "6661"
          }
        },
        "subsidiary": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "9369"
          }
        },
        "approval_policy_assignment": {
          "meta": {
            "included": false
          }
        },
        "teams": {
          "data": []
        },
        "service_types": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        },
        "custom_field_attachments": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "2318",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2423"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "2955"
            }
          ]
        }
      }
    },
    {
      "id": "9368",
      "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
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2423"
          }
        }
      }
    },
    {
      "id": "6661",
      "type": "companies",
      "attributes": {
        "name": "Organization2424",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2025-10-25T06:23:58.859+02:00",
        "last_activity_at": "2025-10-25T06:23:58.859+02: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": "2423"
          }
        },
        "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
          }
        }
      }
    },
    {
      "id": "9369",
      "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
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2423"
          }
        }
      }
    },
    {
      "id": "2955",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Closed",
        "color_id": "1",
        "position": 1,
        "category_id": 3
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2423"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2318"
          }
        }
      }
    }
  ],
  "meta": {}
}

PATCH  /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+json
Body
{
  "data": {
    "type": "survey_fields",
    "attributes": {
      "name": null
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    }
  ]
}

Updates a survey field
PATCH/api/v2/survey_fields/{id}

URI Parameters
HideShow
id
number (required) Example: 1

survey field id

PATCH /api/v2/survey_fields/1/archive
Requestsarchives survey field

PATCH  /api/v2/survey_fields/41/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+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "41",
    "type": "survey_fields",
    "attributes": {
      "created_at": "2025-10-25T06:23:59.146+02:00",
      "updated_at": "2025-10-25T06:23:59.174+02:00",
      "name": "Custom field no.35",
      "data_type_id": 3,
      "required": false,
      "description": null,
      "archived_at": "2025-10-25T06:23:59.000+02: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": "2425"
        }
      },
      "survey": {
        "data": {
          "type": "surveys",
          "id": "24"
        }
      },
      "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": "24",
      "type": "surveys",
      "attributes": {
        "title": "Survey21",
        "description": null,
        "public_uuid": "30139720-ed52-5e15-bdc4-f057036db9f3",
        "submission_access": "nobody",
        "created_at": "2025-10-25T06:23:59.140+02:00",
        "updated_at": "2025-10-25T06:23:59.175+02:00"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2425"
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "1862"
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "9069"
          }
        },
        "updater": {
          "data": {
            "type": "people",
            "id": "9069"
          }
        }
      }
    },
    {
      "id": "18",
      "type": "survey_field_options",
      "attributes": {
        "name": "High",
        "archived_at": "2025-10-25T06:23:59.000+02:00",
        "position": 1,
        "color_id": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2425"
          }
        },
        "survey_field": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "19",
      "type": "survey_field_options",
      "attributes": {
        "name": "High",
        "archived_at": "2025-10-25T06:23:59.000+02:00",
        "position": 1,
        "color_id": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2425"
          }
        },
        "survey_field": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "20",
      "type": "survey_field_options",
      "attributes": {
        "name": "High",
        "archived_at": "2025-10-25T06:23:59.000+02:00",
        "position": 1,
        "color_id": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2425"
          }
        },
        "survey_field": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "1862",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": "1",
        "preferences": {},
        "project_number": "1",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": "2025-10-25T06:23:59.000+02:00",
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2025-10-25T06:23:59.127+02: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": "2425"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "6666"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "9070"
          }
        },
        "last_actor": {
          "data": {
            "type": "people",
            "id": "9069"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2320"
          }
        },
        "custom_field_people": {
          "data": []
        },
        "custom_field_attachments": {
          "meta": {
            "included": false
          }
        },
        "template_object": {
          "data": null
        }
      }
    },
    {
      "id": "9069",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "contact": {},
        "deactivated_at": null,
        "email": "user8952@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": 9030,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "created_at": "2025-10-25T06:23:59.088+02: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": "2425"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "9372"
          }
        },
        "approval_policy_assignment": {
          "meta": {
            "included": false
          }
        },
        "teams": {
          "data": []
        },
        "service_types": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        },
        "custom_field_attachments": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "6666",
      "type": "companies",
      "attributes": {
        "name": "Client4318",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2025-10-25T06:23:59.122+02:00",
        "last_activity_at": "2025-10-25T06:23:59.122+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "CLIE4322",
        "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": "2425"
          }
        },
        "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
          }
        }
      }
    },
    {
      "id": "9070",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "contact": {},
        "deactivated_at": null,
        "email": "user8953@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-10-25T06:23:00.000+02:00",
        "is_user": true,
        "user_id": 9031,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "created_at": "2025-10-25T06:23:59.110+02: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-10-25T06:23:59.110+02: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": "2425"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "6665"
          }
        },
        "subsidiary": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "9373"
          }
        },
        "approval_policy_assignment": {
          "meta": {
            "included": false
          }
        },
        "teams": {
          "data": []
        },
        "service_types": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        },
        "custom_field_attachments": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "2320",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2425"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "2957"
            }
          ]
        }
      }
    },
    {
      "id": "9372",
      "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
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2425"
          }
        }
      }
    },
    {
      "id": "6665",
      "type": "companies",
      "attributes": {
        "name": "Organization2426",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2025-10-25T06:23:59.096+02:00",
        "last_activity_at": "2025-10-25T06:23:59.096+02: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": "2425"
          }
        },
        "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
          }
        }
      }
    },
    {
      "id": "9373",
      "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
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2425"
          }
        }
      }
    },
    {
      "id": "2957",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Closed",
        "color_id": "1",
        "position": 1,
        "category_id": 3
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2425"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2320"
          }
        }
      }
    }
  ],
  "meta": {}
}

Archives a survey field
PATCH/api/v2/survey_fields/{id}/archive

URI Parameters
HideShow
id
number (required) Example: 1

survey field id

Generated by aglio on 25 Oct 2025