List Opportunity Forms | Coperniq

curl https://api.coperniq.io/v1/opportunities/opportunityId/forms \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json"

[
  {
    "id": 101,
    "name": "Site Inspection Form",
    "description": "Form to document the initial site inspection details.",
    "isCompleted": false,
    "createdBy": 45,
    "createdAt": "2024-04-10T08:15:00Z",
    "updatedAt": "2024-04-12T14:22:00Z",
    "templateId": 12,
    "status": "ASSIGNED",
    "dueDate": "2024-04-20T17:00:00Z",
    "assignee": {
      "id": 78,
      "firstName": "Emily",
      "lastName": "Johnson",
      "email": "emily.johnson@example.com",
      "avatarUrl": "https://cdn.coperniq.io/avatars/emily_johnson.png"
    },
    "collaborators": [
      {
        "id": 82,
        "firstName": "Michael",
        "lastName": "Smith",
        "email": "michael.smith@example.com",
        "avatarUrl": "https://cdn.coperniq.io/avatars/michael_smith.png"
      }
    ],
    "opportunityId": 5001
  }
]

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

opportunityIdstringRequired

Opportunity 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

requestIdinteger or null

Associated opportunity ID

collaboratorslist of objects or null

Additional users collaborating on the form

Authentication

Path parameters

Query parameters

Response

Errors