DoCurious API Reference / types / Survey

Interface: Survey

Defined in: types/school.types.ts:350

A survey created by a School Admin for distribution to students or teachers.

Remarks

Surveys link to an external URL (e.g., Google Forms, SurveyMonkey). The platform handles distribution and click tracking via SurveyCampaign.

Extends

• BaseEntity

Properties

createdAt

createdAt: string

Defined in: types/common.types.ts:154

ISO 8601 datetime when the entity was created

Inherited from

BaseEntity.createdAt

---

createdByUserId

createdByUserId: string

Defined in: types/school.types.ts:352

---

description?

optional description: string

Defined in: types/school.types.ts:355

---

endDate?

optional endDate: string

Defined in: types/school.types.ts:364

ISO date when the survey closes

---

externalUrl

externalUrl: string

Defined in: types/school.types.ts:357

URL of the external survey tool where respondents complete the survey

---

id

id: string

Defined in: types/common.types.ts:167

Inherited from

BaseEntity.id

---

schoolId

schoolId: string

Defined in: types/school.types.ts:351

---

startDate?

optional startDate: string

Defined in: types/school.types.ts:362

ISO date when the survey opens for responses

---

status

status: "active" | "draft" | "closed"

Defined in: types/school.types.ts:359

---

templateId?

optional templateId: string

Defined in: types/school.types.ts:367

ID of the template this survey was created from

---

title

title: string

Defined in: types/school.types.ts:354

---

updatedAt

updatedAt: string

Defined in: types/common.types.ts:156

ISO 8601 datetime when the entity was last modified

Inherited from

BaseEntity.updatedAt