List Project Forms

GET

https://api.coperniq.io/v1/projects/:project_id/forms

GET

/v1/projects/:project_id/forms

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

1 [
2   {
3     "id": 1,
4     "name": "string",
5     "description": "string",
6     "isCompleted": true,
7     "createdBy": 1,
8     "createdAt": "2024-01-15T09:30:00Z",
9     "updatedAt": "2024-01-15T09:30:00Z",
10     "templateId": 1,
11     "status": "UNASSIGNED",
12     "dueDate": "2024-01-15T09:30:00Z",
13     "completedAt": "2024-01-15T09:30:00Z",
14     "assignee": {
15       "id": 1,
16       "firstName": "string",
17       "lastName": "string",
18       "email": "string",
19       "avatarUrl": "string"
20     },
21     "projectId": 1,
22     "phaseId": 1,
23     "phaseName": "string",
24     "collaborators": [
25       {
26         "id": 1,
27         "firstName": "string",
28         "lastName": "string",
29         "email": "string",
30         "avatarUrl": "string"
31       }
32     ]
33   }
34 ]

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

project_idintegerRequired

Project identifier

Query parameters

statusenumOptional

Filter forms by status

Response

List of forms

idintegerOptional

Form identifier

namestringOptional

Form name

descriptionstring or nullOptional

Form description

isCompletedbooleanOptional

Whether the form is completed

createdByintegerOptional

ID of user who created the form

createdAtstringOptionalformat: "date-time"

Creation timestamp

updatedAtstringOptionalformat: "date-time"

Last update timestamp

templateIdinteger or nullOptional

Template ID

statusenumOptional

Form status

dueDatestring or nullOptionalformat: "date-time"

Due date

completedAtstring or nullOptionalformat: "date-time"

Completion timestamp

assigneeobjectOptional

Minimal user representation used in responses

projectIdintegerOptional

Associated project ID

phaseIdinteger or nullOptional

Phase template ID (if available)

phaseNamestring or nullOptional

Phase template name (if available)

collaboratorslist of objectsOptional

Additional users collaborating on the form

Errors

401

Unauthorized Error