> For the complete documentation index, see [llms.txt](https://docs.projetly.ai/home/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.projetly.ai/home/api-reference/surveys.md).

# Surveys

## List All Surveys

> This endpoint is used to fetch all surveys in the current organization

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}},"schemas":{"SurveyDetail":{"type":"object","description":"Serializer for survey detail view - all fields","properties":{"survey_id":{"type":"string","maxLength":25},"organization":{"type":"string","maxLength":25},"account_id":{"type":"string","nullable":true,"maxLength":25},"item_type":{"allOf":[{"$ref":"#/components/schemas/ItemTypeEnum"}],"default":"survey"},"name":{"type":"string"},"description":{"type":"string"},"form_structure":{"type":"object","additionalProperties":{}},"form_style":{"type":"string","default":"IN_APP"},"form_container_style":{"type":"string","default":"POPUP"},"background_color":{"type":"string","default":"#F6F7F7"},"background_url":{"type":"string"},"field_border":{"type":"string","default":"Rounded"},"action_color":{"type":"string","default":"#0468BF"},"status":{"type":"string","default":"draft"},"is_active":{"type":"boolean","default":true},"end_date":{"type":"string","format":"date-time","nullable":true},"view_count":{"type":"integer"},"response_count":{"type":"integer"},"field_count":{"type":"string","readOnly":true},"creation_time":{"type":"string","readOnly":true},"tags":{"type":"array","items":{}}},"required":["creation_time","field_count","name","organization","survey_id"]},"ItemTypeEnum":{"enum":["survey","survey_template","form"],"type":"string","description":"* `survey` - survey\n* `survey_template` - survey_template\n* `form` - form"}}},"paths":{"/api/surveys/":{"get":{"operationId":"surveys_list","description":"This endpoint is used to fetch all surveys in the current organization","summary":"List All Surveys","parameters":[{"in":"query","name":"account_id","schema":{"type":"string"},"description":"Filter by account ID"},{"in":"query","name":"items_per_page","schema":{"type":"integer"},"description":"Items Per Page"},{"in":"query","name":"page","schema":{"type":"integer"},"description":"Page Number"},{"in":"query","name":"reverse","schema":{"type":"boolean"},"description":"Sorting Order"},{"in":"query","name":"sort","schema":{"type":"string"},"description":"Sorting Key"},{"in":"query","name":"status","schema":{"type":"string"},"description":"Filter by status (draft, published, closed)"}],"tags":["Surveys"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SurveyDetail"}}}},"description":""}}}}}}
```

## Create Survey

> This endpoint is used to create a new survey for the current organization

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}}},"paths":{"/api/surveys/":{"post":{"operationId":"surveys_create","description":"This endpoint is used to create a new survey for the current organization","summary":"Create Survey","tags":["Surveys"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}}},"responses":{"201":{"description":"No response body"}}}}}}
```

## Get Survey Details

> This endpoint is used to fetch a survey details for the current organization

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}},"schemas":{"SurveyDetail":{"type":"object","description":"Serializer for survey detail view - all fields","properties":{"survey_id":{"type":"string","maxLength":25},"organization":{"type":"string","maxLength":25},"account_id":{"type":"string","nullable":true,"maxLength":25},"item_type":{"allOf":[{"$ref":"#/components/schemas/ItemTypeEnum"}],"default":"survey"},"name":{"type":"string"},"description":{"type":"string"},"form_structure":{"type":"object","additionalProperties":{}},"form_style":{"type":"string","default":"IN_APP"},"form_container_style":{"type":"string","default":"POPUP"},"background_color":{"type":"string","default":"#F6F7F7"},"background_url":{"type":"string"},"field_border":{"type":"string","default":"Rounded"},"action_color":{"type":"string","default":"#0468BF"},"status":{"type":"string","default":"draft"},"is_active":{"type":"boolean","default":true},"end_date":{"type":"string","format":"date-time","nullable":true},"view_count":{"type":"integer"},"response_count":{"type":"integer"},"field_count":{"type":"string","readOnly":true},"creation_time":{"type":"string","readOnly":true},"tags":{"type":"array","items":{}}},"required":["creation_time","field_count","name","organization","survey_id"]},"ItemTypeEnum":{"enum":["survey","survey_template","form"],"type":"string","description":"* `survey` - survey\n* `survey_template` - survey_template\n* `form` - form"}}},"paths":{"/api/surveys/{id}/":{"get":{"operationId":"surveys_retrieve","description":"This endpoint is used to fetch a survey details for the current organization","summary":"Get Survey Details","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Surveys"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveyDetail"}}},"description":""}}}}}}
```

## Update Survey

> This endpoint is used to update a survey for the current organization

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}}},"paths":{"/api/surveys/{id}/":{"put":{"operationId":"surveys_update","description":"This endpoint is used to update a survey for the current organization","summary":"Update Survey","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Surveys"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}}},"responses":{"200":{"description":"No response body"}}}}}}
```

## Delete Survey

> This endpoint is used to delete a survey for the current organization

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}}},"paths":{"/api/surveys/{id}/":{"delete":{"operationId":"surveys_destroy","description":"This endpoint is used to delete a survey for the current organization","summary":"Delete Survey","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Surveys"],"responses":{"204":{"description":"No response body"}}}}}}
```

## Get Automation Options

> This endpoint is used to get automation options (projects and customer users) for a survey

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}}},"paths":{"/api/surveys/{id}/automation-options/":{"get":{"operationId":"surveys_automation_options_retrieve","description":"This endpoint is used to get automation options (projects and customer users) for a survey","summary":"Get Automation Options","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Surveys"],"responses":{"200":{"description":"No response body"}}}}}}
```

## Get Survey Automations

> This endpoint is used to get all automations for a survey

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}}},"paths":{"/api/surveys/{id}/automations/":{"get":{"operationId":"surveys_automations_retrieve","description":"This endpoint is used to get all automations for a survey","summary":"Get Survey Automations","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Surveys"],"responses":{"200":{"description":"No response body"}}}}}}
```

## Create Survey Automation

> This endpoint is used to create a new survey automation

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}},"schemas":{"SurveyDetail":{"type":"object","description":"Serializer for survey detail view - all fields","properties":{"survey_id":{"type":"string","maxLength":25},"organization":{"type":"string","maxLength":25},"account_id":{"type":"string","nullable":true,"maxLength":25},"item_type":{"allOf":[{"$ref":"#/components/schemas/ItemTypeEnum"}],"default":"survey"},"name":{"type":"string"},"description":{"type":"string"},"form_structure":{"type":"object","additionalProperties":{}},"form_style":{"type":"string","default":"IN_APP"},"form_container_style":{"type":"string","default":"POPUP"},"background_color":{"type":"string","default":"#F6F7F7"},"background_url":{"type":"string"},"field_border":{"type":"string","default":"Rounded"},"action_color":{"type":"string","default":"#0468BF"},"status":{"type":"string","default":"draft"},"is_active":{"type":"boolean","default":true},"end_date":{"type":"string","format":"date-time","nullable":true},"view_count":{"type":"integer"},"response_count":{"type":"integer"},"field_count":{"type":"string","readOnly":true},"creation_time":{"type":"string","readOnly":true},"tags":{"type":"array","items":{}}},"required":["creation_time","field_count","name","organization","survey_id"]},"ItemTypeEnum":{"enum":["survey","survey_template","form"],"type":"string","description":"* `survey` - survey\n* `survey_template` - survey_template\n* `form` - form"}}},"paths":{"/api/surveys/{id}/automations_save/":{"post":{"operationId":"surveys_automations_save_create","description":"This endpoint is used to create a new survey automation","summary":"Create Survey Automation","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Surveys"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveyDetail"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/SurveyDetail"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/SurveyDetail"}}},"required":true},"responses":{"201":{"description":"No response body"}}}}}}
```

## Close Survey

> This endpoint is used to close a survey

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}}},"paths":{"/api/surveys/{id}/close/":{"post":{"operationId":"surveys_close_create","description":"This endpoint is used to close a survey","summary":"Close Survey","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Surveys"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}}},"responses":{"200":{"description":"No response body"}}}}}}
```

## Duplicate Survey

> This endpoint is used to duplicate an existing survey

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}}},"paths":{"/api/surveys/{id}/duplicate/":{"post":{"operationId":"surveys_duplicate_create","description":"This endpoint is used to duplicate an existing survey","summary":"Duplicate Survey","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Surveys"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}}},"responses":{"200":{"description":"No response body"}}}}}}
```

## Get Survey For Filling

> Get survey details for filling (authenticated users only)

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}},"schemas":{"SurveyDetail":{"type":"object","description":"Serializer for survey detail view - all fields","properties":{"survey_id":{"type":"string","maxLength":25},"organization":{"type":"string","maxLength":25},"account_id":{"type":"string","nullable":true,"maxLength":25},"item_type":{"allOf":[{"$ref":"#/components/schemas/ItemTypeEnum"}],"default":"survey"},"name":{"type":"string"},"description":{"type":"string"},"form_structure":{"type":"object","additionalProperties":{}},"form_style":{"type":"string","default":"IN_APP"},"form_container_style":{"type":"string","default":"POPUP"},"background_color":{"type":"string","default":"#F6F7F7"},"background_url":{"type":"string"},"field_border":{"type":"string","default":"Rounded"},"action_color":{"type":"string","default":"#0468BF"},"status":{"type":"string","default":"draft"},"is_active":{"type":"boolean","default":true},"end_date":{"type":"string","format":"date-time","nullable":true},"view_count":{"type":"integer"},"response_count":{"type":"integer"},"field_count":{"type":"string","readOnly":true},"creation_time":{"type":"string","readOnly":true},"tags":{"type":"array","items":{}}},"required":["creation_time","field_count","name","organization","survey_id"]},"ItemTypeEnum":{"enum":["survey","survey_template","form"],"type":"string","description":"* `survey` - survey\n* `survey_template` - survey_template\n* `form` - form"}}},"paths":{"/api/surveys/{id}/fill/":{"get":{"operationId":"surveys_fill_retrieve","description":"Get survey details for filling (authenticated users only)","summary":"Get Survey For Filling","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Surveys"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveyDetail"}}},"description":""}}}}}}
```

## Get Survey Insights

> This endpoint is used to get insights/analytics for a survey

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}},"schemas":{"SurveyDetail":{"type":"object","description":"Serializer for survey detail view - all fields","properties":{"survey_id":{"type":"string","maxLength":25},"organization":{"type":"string","maxLength":25},"account_id":{"type":"string","nullable":true,"maxLength":25},"item_type":{"allOf":[{"$ref":"#/components/schemas/ItemTypeEnum"}],"default":"survey"},"name":{"type":"string"},"description":{"type":"string"},"form_structure":{"type":"object","additionalProperties":{}},"form_style":{"type":"string","default":"IN_APP"},"form_container_style":{"type":"string","default":"POPUP"},"background_color":{"type":"string","default":"#F6F7F7"},"background_url":{"type":"string"},"field_border":{"type":"string","default":"Rounded"},"action_color":{"type":"string","default":"#0468BF"},"status":{"type":"string","default":"draft"},"is_active":{"type":"boolean","default":true},"end_date":{"type":"string","format":"date-time","nullable":true},"view_count":{"type":"integer"},"response_count":{"type":"integer"},"field_count":{"type":"string","readOnly":true},"creation_time":{"type":"string","readOnly":true},"tags":{"type":"array","items":{}}},"required":["creation_time","field_count","name","organization","survey_id"]},"ItemTypeEnum":{"enum":["survey","survey_template","form"],"type":"string","description":"* `survey` - survey\n* `survey_template` - survey_template\n* `form` - form"}}},"paths":{"/api/surveys/{id}/insights/":{"get":{"operationId":"surveys_insights_retrieve","description":"This endpoint is used to get insights/analytics for a survey","summary":"Get Survey Insights","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Surveys"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveyDetail"}}},"description":""}}}}}}
```

## Get Survey Limit Status

> Get survey response limit status including current count, blocked count, and remaining responses

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}}},"paths":{"/api/surveys/{id}/limit-status/":{"get":{"operationId":"surveys_limit_status_retrieve","description":"Get survey response limit status including current count, blocked count, and remaining responses","summary":"Get Survey Limit Status","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Surveys"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}},"description":""}}}}}}
```

## Publish Survey

> This endpoint is used to publish a survey

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}}},"paths":{"/api/surveys/{id}/publish/":{"post":{"operationId":"surveys_publish_create","description":"This endpoint is used to publish a survey","summary":"Publish Survey","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Surveys"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}}},"responses":{"200":{"description":"No response body"}}}}}}
```

## Get Survey Responses

> This endpoint is used to get all responses for a survey

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}},"schemas":{"SurveyDetail":{"type":"object","description":"Serializer for survey detail view - all fields","properties":{"survey_id":{"type":"string","maxLength":25},"organization":{"type":"string","maxLength":25},"account_id":{"type":"string","nullable":true,"maxLength":25},"item_type":{"allOf":[{"$ref":"#/components/schemas/ItemTypeEnum"}],"default":"survey"},"name":{"type":"string"},"description":{"type":"string"},"form_structure":{"type":"object","additionalProperties":{}},"form_style":{"type":"string","default":"IN_APP"},"form_container_style":{"type":"string","default":"POPUP"},"background_color":{"type":"string","default":"#F6F7F7"},"background_url":{"type":"string"},"field_border":{"type":"string","default":"Rounded"},"action_color":{"type":"string","default":"#0468BF"},"status":{"type":"string","default":"draft"},"is_active":{"type":"boolean","default":true},"end_date":{"type":"string","format":"date-time","nullable":true},"view_count":{"type":"integer"},"response_count":{"type":"integer"},"field_count":{"type":"string","readOnly":true},"creation_time":{"type":"string","readOnly":true},"tags":{"type":"array","items":{}}},"required":["creation_time","field_count","name","organization","survey_id"]},"ItemTypeEnum":{"enum":["survey","survey_template","form"],"type":"string","description":"* `survey` - survey\n* `survey_template` - survey_template\n* `form` - form"}}},"paths":{"/api/surveys/{id}/responses/":{"get":{"operationId":"surveys_responses_retrieve","description":"This endpoint is used to get all responses for a survey","summary":"Get Survey Responses","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true},{"in":"query","name":"items_per_page","schema":{"type":"integer"},"description":"Items Per Page"},{"in":"query","name":"page","schema":{"type":"integer"},"description":"Page Number"},{"in":"query","name":"respondent_email","schema":{"type":"string"},"description":"Filter by respondent email"}],"tags":["Surveys"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveyDetail"}}},"description":""}}}}}}
```

## Save Survey as Template

> This endpoint is used to save a survey as a template

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}}},"paths":{"/api/surveys/{id}/save-as-template/":{"post":{"operationId":"surveys_save_as_template_create","description":"This endpoint is used to save a survey as a template","summary":"Save Survey as Template","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Surveys"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}}},"responses":{"200":{"description":"No response body"}}}}}}
```

## Schedule Survey Send

> This endpoint is used to schedule a survey to be sent at a specific date/time

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}}},"paths":{"/api/surveys/{id}/schedule/":{"post":{"operationId":"surveys_schedule_create","description":"This endpoint is used to schedule a survey to be sent at a specific date/time","summary":"Schedule Survey Send","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Surveys"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}}},"responses":{"201":{"description":"No response body"}}}}}}
```

## Get Survey Schedules

> This endpoint is used to get all scheduled sends for a survey

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}}},"paths":{"/api/surveys/{id}/schedules/":{"get":{"operationId":"surveys_schedules_retrieve","description":"This endpoint is used to get all scheduled sends for a survey","summary":"Get Survey Schedules","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Surveys"],"responses":{"200":{"description":"No response body"}}}}}}
```

## Send Survey via Email

> This endpoint is used to send a survey via email to specified recipients

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}}},"paths":{"/api/surveys/{id}/send/":{"post":{"operationId":"surveys_send_create","description":"This endpoint is used to send a survey via email to specified recipients","summary":"Send Survey via Email","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Surveys"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}}},"responses":{"200":{"description":"No response body"}}}}}}
```

## Update Survey with Propagation

> This endpoint is used to update a survey and propagate changes to tasks using the form

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}}},"paths":{"/api/surveys/{id}/update-with-propagation/":{"put":{"operationId":"surveys_update_with_propagation_update","description":"This endpoint is used to update a survey and propagate changes to tasks using the form","summary":"Update Survey with Propagation","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Surveys"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}}},"responses":{"200":{"description":"No response body"}}}}}}
```

## Get Form Usage Count

> This endpoint returns the count of non-completed tasks using this form

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}},"schemas":{"SurveyDetail":{"type":"object","description":"Serializer for survey detail view - all fields","properties":{"survey_id":{"type":"string","maxLength":25},"organization":{"type":"string","maxLength":25},"account_id":{"type":"string","nullable":true,"maxLength":25},"item_type":{"allOf":[{"$ref":"#/components/schemas/ItemTypeEnum"}],"default":"survey"},"name":{"type":"string"},"description":{"type":"string"},"form_structure":{"type":"object","additionalProperties":{}},"form_style":{"type":"string","default":"IN_APP"},"form_container_style":{"type":"string","default":"POPUP"},"background_color":{"type":"string","default":"#F6F7F7"},"background_url":{"type":"string"},"field_border":{"type":"string","default":"Rounded"},"action_color":{"type":"string","default":"#0468BF"},"status":{"type":"string","default":"draft"},"is_active":{"type":"boolean","default":true},"end_date":{"type":"string","format":"date-time","nullable":true},"view_count":{"type":"integer"},"response_count":{"type":"integer"},"field_count":{"type":"string","readOnly":true},"creation_time":{"type":"string","readOnly":true},"tags":{"type":"array","items":{}}},"required":["creation_time","field_count","name","organization","survey_id"]},"ItemTypeEnum":{"enum":["survey","survey_template","form"],"type":"string","description":"* `survey` - survey\n* `survey_template` - survey_template\n* `form` - form"}}},"paths":{"/api/surveys/{id}/usage-count/":{"get":{"operationId":"surveys_usage_count_retrieve","description":"This endpoint returns the count of non-completed tasks using this form","summary":"Get Form Usage Count","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Surveys"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveyDetail"}}},"description":""}}}}}}
```

## Update Survey Automation

> This endpoint is used to update an existing survey automation

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}},"schemas":{"SurveyDetail":{"type":"object","description":"Serializer for survey detail view - all fields","properties":{"survey_id":{"type":"string","maxLength":25},"organization":{"type":"string","maxLength":25},"account_id":{"type":"string","nullable":true,"maxLength":25},"item_type":{"allOf":[{"$ref":"#/components/schemas/ItemTypeEnum"}],"default":"survey"},"name":{"type":"string"},"description":{"type":"string"},"form_structure":{"type":"object","additionalProperties":{}},"form_style":{"type":"string","default":"IN_APP"},"form_container_style":{"type":"string","default":"POPUP"},"background_color":{"type":"string","default":"#F6F7F7"},"background_url":{"type":"string"},"field_border":{"type":"string","default":"Rounded"},"action_color":{"type":"string","default":"#0468BF"},"status":{"type":"string","default":"draft"},"is_active":{"type":"boolean","default":true},"end_date":{"type":"string","format":"date-time","nullable":true},"view_count":{"type":"integer"},"response_count":{"type":"integer"},"field_count":{"type":"string","readOnly":true},"creation_time":{"type":"string","readOnly":true},"tags":{"type":"array","items":{}}},"required":["creation_time","field_count","name","organization","survey_id"]},"ItemTypeEnum":{"enum":["survey","survey_template","form"],"type":"string","description":"* `survey` - survey\n* `survey_template` - survey_template\n* `form` - form"}}},"paths":{"/api/surveys/automations/{automation_id}/":{"put":{"operationId":"surveys_automations_update","description":"This endpoint is used to update an existing survey automation","summary":"Update Survey Automation","parameters":[{"in":"path","name":"automation_id","schema":{"type":"string"},"required":true}],"tags":["Surveys"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveyDetail"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/SurveyDetail"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/SurveyDetail"}}},"required":true},"responses":{"200":{"description":"No response body"}}}}}}
```

## Delete Survey Automation

> This endpoint is used to delete a survey automation

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}}},"paths":{"/api/surveys/automations/{automation_id}/":{"delete":{"operationId":"surveys_automations_destroy","description":"This endpoint is used to delete a survey automation","summary":"Delete Survey Automation","parameters":[{"in":"path","name":"automation_id","schema":{"type":"string"},"required":true}],"tags":["Surveys"],"responses":{"200":{"description":"No response body"}}}}}}
```

## Deletes the surveys with the given ids

> This endpoint is used to bulk delete surveys for the current organization

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}},"schemas":{"SurveyDetail":{"type":"object","description":"Serializer for survey detail view - all fields","properties":{"survey_id":{"type":"string","maxLength":25},"organization":{"type":"string","maxLength":25},"account_id":{"type":"string","nullable":true,"maxLength":25},"item_type":{"allOf":[{"$ref":"#/components/schemas/ItemTypeEnum"}],"default":"survey"},"name":{"type":"string"},"description":{"type":"string"},"form_structure":{"type":"object","additionalProperties":{}},"form_style":{"type":"string","default":"IN_APP"},"form_container_style":{"type":"string","default":"POPUP"},"background_color":{"type":"string","default":"#F6F7F7"},"background_url":{"type":"string"},"field_border":{"type":"string","default":"Rounded"},"action_color":{"type":"string","default":"#0468BF"},"status":{"type":"string","default":"draft"},"is_active":{"type":"boolean","default":true},"end_date":{"type":"string","format":"date-time","nullable":true},"view_count":{"type":"integer"},"response_count":{"type":"integer"},"field_count":{"type":"string","readOnly":true},"creation_time":{"type":"string","readOnly":true},"tags":{"type":"array","items":{}}},"required":["creation_time","field_count","name","organization","survey_id"]},"ItemTypeEnum":{"enum":["survey","survey_template","form"],"type":"string","description":"* `survey` - survey\n* `survey_template` - survey_template\n* `form` - form"}}},"paths":{"/api/surveys/bulk-delete/":{"post":{"operationId":"surveys_bulk_delete_create","description":"This endpoint is used to bulk delete surveys for the current organization","summary":"Deletes the surveys with the given ids","tags":["Surveys"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveyDetail"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/SurveyDetail"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/SurveyDetail"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveyDetail"}}},"description":""}}}}}}
```

## Get Survey Counts

> Get counts for surveys, templates, and forms

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}}},"paths":{"/api/surveys/counts/":{"get":{"operationId":"surveys_counts_retrieve","description":"Get counts for surveys, templates, and forms","summary":"Get Survey Counts","tags":["Surveys"],"responses":{"200":{"description":"No response body"}}}}}}
```

## List All Forms

> This endpoint is used to fetch all forms in the current organization

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}},"schemas":{"SurveyDetail":{"type":"object","description":"Serializer for survey detail view - all fields","properties":{"survey_id":{"type":"string","maxLength":25},"organization":{"type":"string","maxLength":25},"account_id":{"type":"string","nullable":true,"maxLength":25},"item_type":{"allOf":[{"$ref":"#/components/schemas/ItemTypeEnum"}],"default":"survey"},"name":{"type":"string"},"description":{"type":"string"},"form_structure":{"type":"object","additionalProperties":{}},"form_style":{"type":"string","default":"IN_APP"},"form_container_style":{"type":"string","default":"POPUP"},"background_color":{"type":"string","default":"#F6F7F7"},"background_url":{"type":"string"},"field_border":{"type":"string","default":"Rounded"},"action_color":{"type":"string","default":"#0468BF"},"status":{"type":"string","default":"draft"},"is_active":{"type":"boolean","default":true},"end_date":{"type":"string","format":"date-time","nullable":true},"view_count":{"type":"integer"},"response_count":{"type":"integer"},"field_count":{"type":"string","readOnly":true},"creation_time":{"type":"string","readOnly":true},"tags":{"type":"array","items":{}}},"required":["creation_time","field_count","name","organization","survey_id"]},"ItemTypeEnum":{"enum":["survey","survey_template","form"],"type":"string","description":"* `survey` - survey\n* `survey_template` - survey_template\n* `form` - form"}}},"paths":{"/api/surveys/forms/":{"get":{"operationId":"surveys_forms_retrieve","description":"This endpoint is used to fetch all forms in the current organization","summary":"List All Forms","parameters":[{"in":"query","name":"account_id","schema":{"type":"string"},"description":"Filter by account ID"},{"in":"query","name":"items_per_page","schema":{"type":"integer"},"description":"Items Per Page"},{"in":"query","name":"page","schema":{"type":"integer"},"description":"Page Number"},{"in":"query","name":"reverse","schema":{"type":"boolean"},"description":"Sorting Order"},{"in":"query","name":"sort","schema":{"type":"string"},"description":"Sorting Key"},{"in":"query","name":"status","schema":{"type":"string"},"description":"Filter by status (draft, published, closed)"}],"tags":["Surveys"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveyDetail"}}},"description":""}}}}}}
```

## Get Survey for Public Submission (Encrypted Token)

> This endpoint is used to get survey details for public submission using encrypted token

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}}},"paths":{"/api/surveys/public/{encrypted_token}/":{"get":{"operationId":"surveys_public_retrieve","description":"This endpoint is used to get survey details for public submission using encrypted token","summary":"Get Survey for Public Submission (Encrypted Token)","parameters":[{"in":"path","name":"encrypted_token","schema":{"type":"string"},"required":true}],"tags":["Surveys"],"responses":{"200":{"description":"No response body"}}}}}}
```

## Cancel Scheduled Survey

> This endpoint is used to cancel a scheduled survey send

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}}},"paths":{"/api/surveys/schedules/{schedule_id}/":{"delete":{"operationId":"surveys_schedules_destroy","description":"This endpoint is used to cancel a scheduled survey send","summary":"Cancel Scheduled Survey","parameters":[{"in":"path","name":"schedule_id","schema":{"type":"string"},"required":true}],"tags":["Surveys"],"responses":{"200":{"description":"No response body"}}}}}}
```

## Get Survey Status Summary

> This endpoint is used to get survey counts by status (total, published, draft, closed)

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}}},"paths":{"/api/surveys/status-summary/":{"get":{"operationId":"surveys_status_summary_retrieve","description":"This endpoint is used to get survey counts by status (total, published, draft, closed)","summary":"Get Survey Status Summary","tags":["Surveys"],"responses":{"200":{"description":"No response body"}}}}}}
```

## Submit Survey Response

> This endpoint is used to submit a response to a survey

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}}},"paths":{"/api/surveys/submit/":{"post":{"operationId":"surveys_submit_create","description":"This endpoint is used to submit a response to a survey","summary":"Submit Survey Response","tags":["Surveys"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}}},"responses":{"200":{"description":"No response body"}}}}}}
```

## List Survey Templates

> This endpoint is used to get survey templates for dropdown selection

```json
{"openapi":"3.0.3","info":{"title":"Projetly API","version":"1.0.0"},"servers":[{"url":"https://api.app.projetly.io"}],"security":[{"bearerAuth":[]},{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /api/login/. Pass as: Authorization: Bearer <token>"}}},"paths":{"/api/surveys/templates/":{"get":{"operationId":"surveys_templates_retrieve","description":"This endpoint is used to get survey templates for dropdown selection","summary":"List Survey Templates","tags":["Surveys"],"responses":{"200":{"description":"No response body"}}}}}}
```