forms

List Opportunity Forms

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.

get/opportunities/{opportunity_id}/forms

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/opportunities/{opportunity_id}/forms
  • Auth: API key in header x-api-key

Path parameters

opportunity_idinteger required

Opportunity identifier

Query parameters

status'UNASSIGNED' | 'ASSIGNED' | 'REVIEW' | 'CHANGES_REQUESTED' | 'COMPLETED' | 'CANCELLED'

Filter forms by status

Response

List of forms

idinteger

Form identifier

namestring

Form name

descriptionstring nullable

Form description

isCompletedboolean

Whether the form is completed

createdByinteger

ID of user who created the form

createdAtstring date-time

Creation timestamp

updatedAtstring date-time

Last update timestamp

templateIdinteger nullable

Template ID

status'UNASSIGNED' | 'ASSIGNED' | 'REVIEW' | 'CHANGES_REQUESTED' | 'COMPLETED' | 'CANCELLED'

Form status

dueDatestring date-time nullable

Due date

completedAtstring date-time nullable

Completion timestamp

requestIdinteger

Associated opportunity ID

Changes

No recorded changes to this operation across all 1 revision of this API.