List Project Forms | Coperniq API

const url = 'https://api.coperniq.io/v1/projects/1/forms';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

[
  {
    "id": 1,
    "name": "string",
    "description": "string",
    "isCompleted": true,
    "createdBy": 1,
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "templateId": 1,
    "status": "UNASSIGNED",
    "dueDate": "2024-01-15T09:30:00Z",
    "completedAt": "2024-01-15T09:30:00Z",
    "assignee": {
      "id": 1,
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "avatarUrl": "string"
    },
    "projectId": 1,
    "phaseId": 1,
    "phaseName": "string",
    "collaborators": [
      {
        "id": 1,
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "avatarUrl": "string"
      }
    ]
  }
]

Retrieve all forms associated with a project.

Supports:

Status filtering (status query parameter)

Retrieve all forms associated with a project. Supports: - Status filtering (`status` query parameter)

Authentication

x-api-keystring

API Key authentication via header

Path parameters

projectIdintegerRequired

Project identifier

Query parameters

statusenumOptional

Filter forms by status

Response

List of forms

idinteger

Form identifier

namestring

Form name

descriptionstring or null

Form description

isCompletedboolean

Whether the form is completed

createdByinteger

ID of user who created the form

createdAtstringformat: "date-time"

Creation timestamp

updatedAtstringformat: "date-time"

Last update timestamp

templateIdinteger or null

Template ID

statusenum

Form status

dueDatestring or nullformat: "date-time"

Due date

completedAtstring or nullformat: "date-time"

Completion timestamp

assigneeobject

Minimal user representation used in responses

projectIdinteger

Associated project ID

phaseIdinteger or null

Phase template ID (if available)

phaseNamestring or null

Phase template name (if available)

collaboratorslist of objects

Additional users collaborating on the form

Errors

401

Unauthorized Error