API ReferenceForms

List Project Forms

Retrieve all forms associated with a project.

Supports:

  • Status filtering (status query parameter)

Authentication

x-api-keystring
API Key authentication via header

Path parameters

projectIdstringRequired
Project identifier

Query parameters

statusenumOptional
Filter forms by status

Response

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

Phase template ID (if available)

phaseNamestring or null

Phase template name (if available)

Errors