List Opportunity Forms | Coperniq API

const url = 'https://api.coperniq.io/v1/opportunities/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"
    },
    "requestId": 1,
    "collaborators": [
      {
        "id": 1,
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "avatarUrl": "string"
      }
    ]
  }
]

Retrieve all forms associated with an opportunity.

Supports:

Status filtering (status query parameter)

Note: The /requests path is an alias for /opportunities and will continue to work until users are individually notified and migrated.

Retrieve all forms associated with an opportunity. Supports: - Status filtering (`status` query parameter) **Note:** The `/requests` path is an alias for `/opportunities` and will continue to work until users are individually notified and migrated.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

opportunity_idintegerRequired

Opportunity 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

requestIdintegerOptional

Associated opportunity ID

collaboratorslist of objectsOptional

Additional users collaborating on the form

Errors

401

Unauthorized Error