Docs

Get Intake Submission

GET /Events/{eventId}/intake

GET/Events/{eventId}/intake

Required Tokens

FieldTypeRequiredDescription
BearerAuthorization: Bearer <api-key>OptionalYour API key. Pass it as the Bearer token on every request.
Event tokenx-Event-TokenOptionalRun **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually. An organization token from a member of the event's organization is accepted instead.

Returns the event's current intake submission, the form it is answered against (read live), and every earlier submission. On a draft the form comes from the event's current type. On an active event it is the current submission's form, or, when nothing is current, the type's form unanswered.

Requires read access to the event.

Path Parameters

FieldTypeRequiredDescription
eventIdGuidRequiredThe event to read the intake for.

Response

FieldTypeDescription
intakeFormIdGuid| nullThe form shown. `null` when the event has no intake to fill.
submittedDateDateTime| nullWhen the current submission was submitted. `null` on a draft or when nothing is current.
isEditableboolWhether `PATCH /Events/{eventId}/intake/answers` accepts edits: the event is active and has a current submission.
canRetakeboolWhether `POST /Events/{eventId}/intake/submissions` accepts a re-take: the event is active, nothing is current, and its type has a form.
answersAnswer[]Answers on the current submission.
formIntakeForm| nullThe form shown, with its questions and options.
historyPriorSubmission[]Earlier submissions, newest first. Each carries its own form.
typeChangeTypeChange| nullSet when the event's type moved off the form its prior intake was taken on and nothing is current. `null` for an event that never had an intake.

Answer

FieldTypeDescription
questionIdGuidThe question answered.
valuestring| nullThe stored value. `null` when cleared.
modifiedDateDateTime| nullWhen the answer was last edited after activation. `null` if never edited.
modifiedByUserIdGuid| nullWho last edited it.
modifiedByNamestringDisplay name of the editor, when resolvable.

PriorSubmission

FieldTypeDescription
idGuidSubmission ID.
intakeFormIdGuidThe form it was taken on.
intakeFormNamestringThat form's name.
submittedDateDateTime| nullWhen it was submitted.
formIntakeForm| nullThat form, read live.
answersAnswer[]Its answers.

TypeChange

FieldTypeDescription
priorSubmissionIdGuidThe most recent earlier submission.
priorIntakeFormNamestringThe form it was taken on.