API ReferenceForms

Get Form

Retrieve a specific form by ID with detailed layout information

Authentication

x-api-keystring
API Key authentication via header

Path parameters

formIdstringRequired
Form identifier

Response

Form details
idinteger or null
Form identifier
namestring or null
Form name
descriptionstring or null
Form description
templateIdinteger or null
Template ID
updatedAtstring or nullformat: "date-time"
Last update timestamp
statusenum or null
Form status
isCompletedboolean or null
Whether the form is completed
completedAtstring or nullformat: "date-time"
Completion timestamp
createdAtstring or nullformat: "date-time"
Creation timestamp
createdByUserobject or null
Minimal user representation used in responses
assigneeobject or null
Minimal user representation used in responses
dueDatestring or nullformat: "date-time"
Due date
projectIdinteger or null
Associated project ID
phaseIdinteger or null

Phase template ID (if available)

phaseNamestring or null

Phase template name (if available)

formLayoutslist of objects or null
Form layout sections

Errors