Technical - Properties Guide
This document provides a concise list of commonly used property names across multiple endpoints in the API. Each property is shown in code fences for quick reference, followed by a short description.
Property ListCopied!
π Id Properties (Ending with Id
Suffix)Copied!
Properties ending with Id
contain a GUID and are used to identify entities across the API. Id properties with the same name refer to the same entity, regardless of the endpoint or whether it is a parameter or part of the body content.
QuestId
A unique identifier for a βQuestβ (a project container with invitations, survey questions, reports, etc.).
QuestionId
A unique identifier for a specific question within a Questβs survey.
AlternativeId
A unique identifier for an alternative/choice associated with a specific question.
FieldId
A unique identifier for a field holding respondent data connected to a respondent.
FieldValueId
A unique identifier for a field value belonging to a specific FieldId
that has discrete values.
InvitationId
A unique identifier for an invitation to a survey.
ResponseId
A unique identifier for a submitted survey response.
ExportId
A unique identifier for a data export artifact or export job.
π Date Properties (Ending with At
Suffix)Copied!
Properties ending with At
(like startingAt
, endingAt
) represent points in time (timestamps). These properties follow the format yyyy-MM-ddThh:mm:ss.ffffffZ
using a 24-hour clock and are based on ISO 8601.
startAt
: Indicates when a survey or invitation becomes active.endAt
: Indicates when the survey or invitation closes or expires.
Other Common PropertiesCopied!
LanguageCode
Specifies the language code, typically following the BCP 47 format (e.g., en-GB
, sv-SE
).
OrderNumber
Represents the ordering or position of an item, such as the sequence of questions or alternatives. (Note: This is not unique across different objects.)