Ctrlk
API DocsProjetlyProjetly Blogs
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Surveys

List All Surveys

get

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

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Query parameters
account_idstringOptional

Filter by account ID

items_per_pageintegerOptional

Items Per Page

pageintegerOptional

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

statusstringOptional

Filter by status (draft, published, closed)

Responses
200Success
application/json

Serializer for survey detail view - all fields

survey_idstring · max: 25Required
organizationstring · max: 25Required
account_idstring · max: 25 · nullableOptional
item_typestring · enumOptional
  • survey - survey
  • survey_template - survey_template
  • form - form
Possible values:
namestringRequired
descriptionstringOptional
form_stylestringOptionalDefault: IN_APP
form_container_stylestringOptionalDefault: POPUP
background_colorstringOptionalDefault: #F6F7F7
background_urlstringOptional
field_borderstringOptionalDefault: Rounded
action_colorstringOptionalDefault: #0468BF
statusstringOptionalDefault: draft
is_activebooleanOptionalDefault: true
end_datestring · date-time · nullableOptional
view_countintegerOptional
response_countintegerOptional
field_countstringRead-onlyRequired
creation_timestringRead-onlyRequired
get/api/surveys/
GET /api/surveys/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
[
  {
    "survey_id": "text",
    "organization": "text",
    "account_id": "text",
    "item_type": "survey",
    "name": "text",
    "description": "text",
    "form_structure": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "form_style": "IN_APP",
    "form_container_style": "POPUP",
    "background_color": "#F6F7F7",
    "background_url": "text",
    "field_border": "Rounded",
    "action_color": "#0468BF",
    "status": "draft",
    "is_active": true,
    "end_date": "2026-01-01T00:00:00.000Z",
    "view_count": 1,
    "response_count": 1,
    "field_count": "text",
    "creation_time": "text",
    "tags": []
  }
]

Create Survey

post

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

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Body
Other propertiesanyOptional
Responses
201

No response body

No content
post/api/surveys/
POST /api/surveys/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 422

{
  "name": "Customer Satisfaction Survey",
  "description": "Quarterly customer satisfaction survey",
  "account_id": "123",
  "form_structure": [
    {
      "id": "page1",
      "title": "Page 1",
      "fields": [
        {
          "id": "field1",
          "type": "short-text",
          "label": "What is your name?",
          "required": true
        },
        {
          "id": "field2",
          "type": "ratings",
          "label": "How satisfied are you?",
          "required": true,
          "maxRating": 5
        }
      ]
    }
  ],
  "form_style": "IN_APP",
  "form_container_style": "POPUP",
  "status": "draft"
}
201

No response body

No content

Get Survey Details

get

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

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
idstringRequired
Responses
200Success
application/json

Serializer for survey detail view - all fields

survey_idstring · max: 25Required
organizationstring · max: 25Required
account_idstring · max: 25 · nullableOptional
item_typestring · enumOptional
  • survey - survey
  • survey_template - survey_template
  • form - form
Possible values:
namestringRequired
descriptionstringOptional
form_stylestringOptionalDefault: IN_APP
form_container_stylestringOptionalDefault: POPUP
background_colorstringOptionalDefault: #F6F7F7
background_urlstringOptional
field_borderstringOptionalDefault: Rounded
action_colorstringOptionalDefault: #0468BF
statusstringOptionalDefault: draft
is_activebooleanOptionalDefault: true
end_datestring · date-time · nullableOptional
view_countintegerOptional
response_countintegerOptional
field_countstringRead-onlyRequired
creation_timestringRead-onlyRequired
get/api/surveys/{id}/
GET /api/surveys/{id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "survey_id": "text",
  "organization": "text",
  "account_id": "text",
  "item_type": "survey",
  "name": "text",
  "description": "text",
  "form_structure": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "form_style": "IN_APP",
  "form_container_style": "POPUP",
  "background_color": "#F6F7F7",
  "background_url": "text",
  "field_border": "Rounded",
  "action_color": "#0468BF",
  "status": "draft",
  "is_active": true,
  "end_date": "2026-01-01T00:00:00.000Z",
  "view_count": 1,
  "response_count": 1,
  "field_count": "text",
  "creation_time": "text",
  "tags": []
}

Update Survey

put

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

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
idstringRequired
Body
Other propertiesanyOptional
Responses
200

No response body

No content
put/api/surveys/{id}/
PUT /api/surveys/{id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "survey_id": "123",
  "name": "Updated Survey Name",
  "description": "Updated description",
  "status": "published"
}
200

No response body

No content

Delete Survey

delete

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

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
idstringRequired
Responses
204

No response body

No content
delete/api/surveys/{id}/
DELETE /api/surveys/{id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

No response body

No content

Get Automation Options

get

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

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
idstringRequired
Responses
200

No response body

No content
get/api/surveys/{id}/automation-options/
GET /api/surveys/{id}/automation-options/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

No response body

No content

Get Survey Automations

get

This endpoint is used to get all automations for a survey

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
idstringRequired
Responses
200

No response body

No content
get/api/surveys/{id}/automations/
GET /api/surveys/{id}/automations/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

No response body

No content

Create Survey Automation

post

This endpoint is used to create a new survey automation

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
idstringRequired
Body

Serializer for survey detail view - all fields

survey_idstring · max: 25Required
organizationstring · max: 25Required
account_idstring · max: 25 · nullableOptional
item_typestring · enumOptional
  • survey - survey
  • survey_template - survey_template
  • form - form
Possible values:
namestringRequired
descriptionstringOptional
form_stylestringOptionalDefault: IN_APP
form_container_stylestringOptionalDefault: POPUP
background_colorstringOptionalDefault: #F6F7F7
background_urlstringOptional
field_borderstringOptionalDefault: Rounded
action_colorstringOptionalDefault: #0468BF
statusstringOptionalDefault: draft
is_activebooleanOptionalDefault: true
end_datestring · date-time · nullableOptional
view_countintegerOptional
response_countintegerOptional
field_countstringRead-onlyRequired
creation_timestringRead-onlyRequired
Responses
201

No response body

No content
post/api/surveys/{id}/automations_save/
POST /api/surveys/{id}/automations_save/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 446

{
  "survey_id": "text",
  "organization": "text",
  "account_id": "text",
  "item_type": "survey",
  "name": "text",
  "description": "text",
  "form_structure": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "form_style": "IN_APP",
  "form_container_style": "POPUP",
  "background_color": "#F6F7F7",
  "background_url": "text",
  "field_border": "Rounded",
  "action_color": "#0468BF",
  "status": "draft",
  "is_active": true,
  "end_date": "2026-01-01T00:00:00.000Z",
  "view_count": 1,
  "response_count": 1,
  "tags": []
}
201

No response body

No content

Close Survey

post

This endpoint is used to close a survey

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
idstringRequired
Body
Other propertiesanyOptional
Responses
200

No response body

No content
post/api/surveys/{id}/close/
POST /api/surveys/{id}/close/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}
200

No response body

No content

Duplicate Survey

post

This endpoint is used to duplicate an existing survey

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
idstringRequired
Body
Other propertiesanyOptional
Responses
200

No response body

No content
post/api/surveys/{id}/duplicate/
POST /api/surveys/{id}/duplicate/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "name": "Survey Name (Copy)"
}
200

No response body

No content

Get Survey For Filling

get

Get survey details for filling (authenticated users only)

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
idstringRequired
Responses
200Success
application/json

Serializer for survey detail view - all fields

survey_idstring · max: 25Required
organizationstring · max: 25Required
account_idstring · max: 25 · nullableOptional
item_typestring · enumOptional
  • survey - survey
  • survey_template - survey_template
  • form - form
Possible values:
namestringRequired
descriptionstringOptional
form_stylestringOptionalDefault: IN_APP
form_container_stylestringOptionalDefault: POPUP
background_colorstringOptionalDefault: #F6F7F7
background_urlstringOptional
field_borderstringOptionalDefault: Rounded
action_colorstringOptionalDefault: #0468BF
statusstringOptionalDefault: draft
is_activebooleanOptionalDefault: true
end_datestring · date-time · nullableOptional
view_countintegerOptional
response_countintegerOptional
field_countstringRead-onlyRequired
creation_timestringRead-onlyRequired
get/api/surveys/{id}/fill/
GET /api/surveys/{id}/fill/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "survey_id": "text",
  "organization": "text",
  "account_id": "text",
  "item_type": "survey",
  "name": "text",
  "description": "text",
  "form_structure": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "form_style": "IN_APP",
  "form_container_style": "POPUP",
  "background_color": "#F6F7F7",
  "background_url": "text",
  "field_border": "Rounded",
  "action_color": "#0468BF",
  "status": "draft",
  "is_active": true,
  "end_date": "2026-01-01T00:00:00.000Z",
  "view_count": 1,
  "response_count": 1,
  "field_count": "text",
  "creation_time": "text",
  "tags": []
}

Get Survey Insights

get

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

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
idstringRequired
Responses
200Success
application/json

Serializer for survey detail view - all fields

survey_idstring · max: 25Required
organizationstring · max: 25Required
account_idstring · max: 25 · nullableOptional
item_typestring · enumOptional
  • survey - survey
  • survey_template - survey_template
  • form - form
Possible values:
namestringRequired
descriptionstringOptional
form_stylestringOptionalDefault: IN_APP
form_container_stylestringOptionalDefault: POPUP
background_colorstringOptionalDefault: #F6F7F7
background_urlstringOptional
field_borderstringOptionalDefault: Rounded
action_colorstringOptionalDefault: #0468BF
statusstringOptionalDefault: draft
is_activebooleanOptionalDefault: true
end_datestring · date-time · nullableOptional
view_countintegerOptional
response_countintegerOptional
field_countstringRead-onlyRequired
creation_timestringRead-onlyRequired
get/api/surveys/{id}/insights/
GET /api/surveys/{id}/insights/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "survey_id": "text",
  "organization": "text",
  "account_id": "text",
  "item_type": "survey",
  "name": "text",
  "description": "text",
  "form_structure": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "form_style": "IN_APP",
  "form_container_style": "POPUP",
  "background_color": "#F6F7F7",
  "background_url": "text",
  "field_border": "Rounded",
  "action_color": "#0468BF",
  "status": "draft",
  "is_active": true,
  "end_date": "2026-01-01T00:00:00.000Z",
  "view_count": 1,
  "response_count": 1,
  "field_count": "text",
  "creation_time": "text",
  "tags": []
}

Get Survey Limit Status

get

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

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
idstringRequired
Responses
200Success
application/json
Other propertiesanyOptional
get/api/surveys/{id}/limit-status/
GET /api/surveys/{id}/limit-status/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Publish Survey

post

This endpoint is used to publish a survey

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
idstringRequired
Body
Other propertiesanyOptional
Responses
200

No response body

No content
post/api/surveys/{id}/publish/
POST /api/surveys/{id}/publish/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}
200

No response body

No content

Get Survey Responses

get

This endpoint is used to get all responses for a survey

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
idstringRequired
Query parameters
items_per_pageintegerOptional

Items Per Page

pageintegerOptional

Page Number

respondent_emailstringOptional

Filter by respondent email

Responses
200Success
application/json

Serializer for survey detail view - all fields

survey_idstring · max: 25Required
organizationstring · max: 25Required
account_idstring · max: 25 · nullableOptional
item_typestring · enumOptional
  • survey - survey
  • survey_template - survey_template
  • form - form
Possible values:
namestringRequired
descriptionstringOptional
form_stylestringOptionalDefault: IN_APP
form_container_stylestringOptionalDefault: POPUP
background_colorstringOptionalDefault: #F6F7F7
background_urlstringOptional
field_borderstringOptionalDefault: Rounded
action_colorstringOptionalDefault: #0468BF
statusstringOptionalDefault: draft
is_activebooleanOptionalDefault: true
end_datestring · date-time · nullableOptional
view_countintegerOptional
response_countintegerOptional
field_countstringRead-onlyRequired
creation_timestringRead-onlyRequired
get/api/surveys/{id}/responses/
GET /api/surveys/{id}/responses/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "survey_id": "text",
  "organization": "text",
  "account_id": "text",
  "item_type": "survey",
  "name": "text",
  "description": "text",
  "form_structure": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "form_style": "IN_APP",
  "form_container_style": "POPUP",
  "background_color": "#F6F7F7",
  "background_url": "text",
  "field_border": "Rounded",
  "action_color": "#0468BF",
  "status": "draft",
  "is_active": true,
  "end_date": "2026-01-01T00:00:00.000Z",
  "view_count": 1,
  "response_count": 1,
  "field_count": "text",
  "creation_time": "text",
  "tags": []
}

Save Survey as Template

post

This endpoint is used to save a survey as a template

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
idstringRequired
Body
Other propertiesanyOptional
Responses
200

No response body

No content
post/api/surveys/{id}/save-as-template/
POST /api/surveys/{id}/save-as-template/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "name": "Customer Feedback Template"
}
200

No response body

No content

Schedule Survey Send

post

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

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
idstringRequired
Body
Other propertiesanyOptional
Responses
201

No response body

No content
post/api/surveys/{id}/schedule/
POST /api/surveys/{id}/schedule/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 192

{
  "email_addresses": [
    "user1@example.com",
    "user2@example.com"
  ],
  "custom_message": "Please take a moment to complete this survey",
  "scheduled_at": "2024-01-15T10:00:00",
  "timezone": "America/New_York"
}
201

No response body

No content

Get Survey Schedules

get

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

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
idstringRequired
Responses
200

No response body

No content
get/api/surveys/{id}/schedules/
GET /api/surveys/{id}/schedules/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

No response body

No content

Send Survey via Email

post

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

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
idstringRequired
Body
Other propertiesanyOptional
Responses
200

No response body

No content
post/api/surveys/{id}/send/
POST /api/surveys/{id}/send/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "email_addresses": [
    "user1@example.com",
    "user2@example.com"
  ],
  "custom_message": "Please take a moment to complete this survey"
}
200

No response body

No content

Update Survey with Propagation

put

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

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
idstringRequired
Body
Other propertiesanyOptional
Responses
200

No response body

No content
put/api/surveys/{id}/update-with-propagation/
PUT /api/surveys/{id}/update-with-propagation/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "name": "Updated Survey Name",
  "form_structure": {
    "fields": []
  },
  "propagate_to_tasks": true
}
200

No response body

No content

Get Form Usage Count

get

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

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
idstringRequired
Responses
200Success
application/json

Serializer for survey detail view - all fields

survey_idstring · max: 25Required
organizationstring · max: 25Required
account_idstring · max: 25 · nullableOptional
item_typestring · enumOptional
  • survey - survey
  • survey_template - survey_template
  • form - form
Possible values:
namestringRequired
descriptionstringOptional
form_stylestringOptionalDefault: IN_APP
form_container_stylestringOptionalDefault: POPUP
background_colorstringOptionalDefault: #F6F7F7
background_urlstringOptional
field_borderstringOptionalDefault: Rounded
action_colorstringOptionalDefault: #0468BF
statusstringOptionalDefault: draft
is_activebooleanOptionalDefault: true
end_datestring · date-time · nullableOptional
view_countintegerOptional
response_countintegerOptional
field_countstringRead-onlyRequired
creation_timestringRead-onlyRequired
get/api/surveys/{id}/usage-count/
GET /api/surveys/{id}/usage-count/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "survey_id": "text",
  "organization": "text",
  "account_id": "text",
  "item_type": "survey",
  "name": "text",
  "description": "text",
  "form_structure": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "form_style": "IN_APP",
  "form_container_style": "POPUP",
  "background_color": "#F6F7F7",
  "background_url": "text",
  "field_border": "Rounded",
  "action_color": "#0468BF",
  "status": "draft",
  "is_active": true,
  "end_date": "2026-01-01T00:00:00.000Z",
  "view_count": 1,
  "response_count": 1,
  "field_count": "text",
  "creation_time": "text",
  "tags": []
}

Update Survey Automation

put

This endpoint is used to update an existing survey automation

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
automation_idstringRequired
Body

Serializer for survey detail view - all fields

survey_idstring · max: 25Required
organizationstring · max: 25Required
account_idstring · max: 25 · nullableOptional
item_typestring · enumOptional
  • survey - survey
  • survey_template - survey_template
  • form - form
Possible values:
namestringRequired
descriptionstringOptional
form_stylestringOptionalDefault: IN_APP
form_container_stylestringOptionalDefault: POPUP
background_colorstringOptionalDefault: #F6F7F7
background_urlstringOptional
field_borderstringOptionalDefault: Rounded
action_colorstringOptionalDefault: #0468BF
statusstringOptionalDefault: draft
is_activebooleanOptionalDefault: true
end_datestring · date-time · nullableOptional
view_countintegerOptional
response_countintegerOptional
field_countstringRead-onlyRequired
creation_timestringRead-onlyRequired
Responses
200

No response body

No content
put/api/surveys/automations/{automation_id}/
PUT /api/surveys/automations/{automation_id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 446

{
  "survey_id": "text",
  "organization": "text",
  "account_id": "text",
  "item_type": "survey",
  "name": "text",
  "description": "text",
  "form_structure": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "form_style": "IN_APP",
  "form_container_style": "POPUP",
  "background_color": "#F6F7F7",
  "background_url": "text",
  "field_border": "Rounded",
  "action_color": "#0468BF",
  "status": "draft",
  "is_active": true,
  "end_date": "2026-01-01T00:00:00.000Z",
  "view_count": 1,
  "response_count": 1,
  "tags": []
}
200

No response body

No content

Delete Survey Automation

delete

This endpoint is used to delete a survey automation

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
automation_idstringRequired
Responses
200

No response body

No content
delete/api/surveys/automations/{automation_id}/
DELETE /api/surveys/automations/{automation_id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

No response body

No content

Deletes the surveys with the given ids

post

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

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Body

Serializer for survey detail view - all fields

survey_idstring · max: 25Required
organizationstring · max: 25Required
account_idstring · max: 25 · nullableOptional
item_typestring · enumOptional
  • survey - survey
  • survey_template - survey_template
  • form - form
Possible values:
namestringRequired
descriptionstringOptional
form_stylestringOptionalDefault: IN_APP
form_container_stylestringOptionalDefault: POPUP
background_colorstringOptionalDefault: #F6F7F7
background_urlstringOptional
field_borderstringOptionalDefault: Rounded
action_colorstringOptionalDefault: #0468BF
statusstringOptionalDefault: draft
is_activebooleanOptionalDefault: true
end_datestring · date-time · nullableOptional
view_countintegerOptional
response_countintegerOptional
field_countstringRead-onlyRequired
creation_timestringRead-onlyRequired
Responses
200Success
application/json

Serializer for survey detail view - all fields

survey_idstring · max: 25Required
organizationstring · max: 25Required
account_idstring · max: 25 · nullableOptional
item_typestring · enumOptional
  • survey - survey
  • survey_template - survey_template
  • form - form
Possible values:
namestringRequired
descriptionstringOptional
form_stylestringOptionalDefault: IN_APP
form_container_stylestringOptionalDefault: POPUP
background_colorstringOptionalDefault: #F6F7F7
background_urlstringOptional
field_borderstringOptionalDefault: Rounded
action_colorstringOptionalDefault: #0468BF
statusstringOptionalDefault: draft
is_activebooleanOptionalDefault: true
end_datestring · date-time · nullableOptional
view_countintegerOptional
response_countintegerOptional
field_countstringRead-onlyRequired
creation_timestringRead-onlyRequired
post/api/surveys/bulk-delete/
POST /api/surveys/bulk-delete/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 446

{
  "survey_id": "text",
  "organization": "text",
  "account_id": "text",
  "item_type": "survey",
  "name": "text",
  "description": "text",
  "form_structure": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "form_style": "IN_APP",
  "form_container_style": "POPUP",
  "background_color": "#F6F7F7",
  "background_url": "text",
  "field_border": "Rounded",
  "action_color": "#0468BF",
  "status": "draft",
  "is_active": true,
  "end_date": "2026-01-01T00:00:00.000Z",
  "view_count": 1,
  "response_count": 1,
  "tags": []
}
200Success
{
  "survey_id": "text",
  "organization": "text",
  "account_id": "text",
  "item_type": "survey",
  "name": "text",
  "description": "text",
  "form_structure": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "form_style": "IN_APP",
  "form_container_style": "POPUP",
  "background_color": "#F6F7F7",
  "background_url": "text",
  "field_border": "Rounded",
  "action_color": "#0468BF",
  "status": "draft",
  "is_active": true,
  "end_date": "2026-01-01T00:00:00.000Z",
  "view_count": 1,
  "response_count": 1,
  "field_count": "text",
  "creation_time": "text",
  "tags": []
}

Get Survey Counts

get

Get counts for surveys, templates, and forms

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Responses
200

No response body

No content
get/api/surveys/counts/
GET /api/surveys/counts/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

No response body

No content

List All Forms

get

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

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Query parameters
account_idstringOptional

Filter by account ID

items_per_pageintegerOptional

Items Per Page

pageintegerOptional

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

statusstringOptional

Filter by status (draft, published, closed)

Responses
200Success
application/json

Serializer for survey detail view - all fields

survey_idstring · max: 25Required
organizationstring · max: 25Required
account_idstring · max: 25 · nullableOptional
item_typestring · enumOptional
  • survey - survey
  • survey_template - survey_template
  • form - form
Possible values:
namestringRequired
descriptionstringOptional
form_stylestringOptionalDefault: IN_APP
form_container_stylestringOptionalDefault: POPUP
background_colorstringOptionalDefault: #F6F7F7
background_urlstringOptional
field_borderstringOptionalDefault: Rounded
action_colorstringOptionalDefault: #0468BF
statusstringOptionalDefault: draft
is_activebooleanOptionalDefault: true
end_datestring · date-time · nullableOptional
view_countintegerOptional
response_countintegerOptional
field_countstringRead-onlyRequired
creation_timestringRead-onlyRequired
get/api/surveys/forms/
GET /api/surveys/forms/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "survey_id": "text",
  "organization": "text",
  "account_id": "text",
  "item_type": "survey",
  "name": "text",
  "description": "text",
  "form_structure": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "form_style": "IN_APP",
  "form_container_style": "POPUP",
  "background_color": "#F6F7F7",
  "background_url": "text",
  "field_border": "Rounded",
  "action_color": "#0468BF",
  "status": "draft",
  "is_active": true,
  "end_date": "2026-01-01T00:00:00.000Z",
  "view_count": 1,
  "response_count": 1,
  "field_count": "text",
  "creation_time": "text",
  "tags": []
}

Get Survey for Public Submission (Encrypted Token)

get

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

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
encrypted_tokenstringRequired
Responses
200

No response body

No content
get/api/surveys/public/{encrypted_token}/
GET /api/surveys/public/{encrypted_token}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

No response body

No content

Cancel Scheduled Survey

delete

This endpoint is used to cancel a scheduled survey send

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters
schedule_idstringRequired
Responses
200

No response body

No content
delete/api/surveys/schedules/{schedule_id}/
DELETE /api/surveys/schedules/{schedule_id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

No response body

No content

Get Survey Status Summary

get

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

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Responses
200

No response body

No content
get/api/surveys/status-summary/
GET /api/surveys/status-summary/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

No response body

No content

Submit Survey Response

post

This endpoint is used to submit a response to a survey

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Body
Other propertiesanyOptional
Responses
200

No response body

No content
post/api/surveys/submit/
POST /api/surveys/submit/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "responses": {
    "field1": "John Doe",
    "field2": 5
  },
  "respondent_email": "john@example.com",
  "completion_time_seconds": 120,
  "is_complete": true
}
200

No response body

No content

List Survey Templates

get

This endpoint is used to get survey templates for dropdown selection

Authorizations
AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Responses
200

No response body

No content
get/api/surveys/templates/
GET /api/surveys/templates/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

No response body

No content
PreviousProjectsNextTags

Last updated