Get Form Template | Coperniq

curl https://api.coperniq.io/v1/form-templates/1 \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json"

{
  "id": 1,
  "name": "Project Intake Form",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-04-10T11:45:00Z",
  "assignee": {
    "id": 42,
    "firstName": "Alice",
    "lastName": "Johnson",
    "email": "alice.johnson@coperniq.io"
  },
  "assigneeProperty": "OWNER",
  "collaborators": [
    {
      "id": 58,
      "firstName": "Bob",
      "lastName": "Smith",
      "email": "bob.smith@coperniq.io"
    }
  ],
  "collaboratorProperties": [
    "SALES_REP"
  ],
  "labels": [
    {
      "id": 3,
      "label": "Urgent",
      "color": "#FF0000"
    }
  ],
  "dueDateXDaysAfter": 7,
  "formLayouts": [
    {
      "id": 101,
      "name": "Client Information",
      "type": "GROUP",
      "properties": [
        {
          "id": 102,
          "name": "Client Name",
          "type": "COLUMN",
          "columnId": 201,
          "column": {
            "id": 201,
            "name": "Client Name",
            "type": "TEXT",
            "multiple": false,
            "isRequired": true,
            "isReadOnly": false
          }
        },
        {
          "id": 103,
          "name": "Primary Contact Email",
          "type": "COLUMN",
          "columnId": 202,
          "column": {
            "id": 202,
            "name": "Primary Email",
            "type": "TEXT",
            "multiple": false,
            "isRequired": true,
            "isReadOnly": false
          }
        },
        {
          "id": 104,
          "name": "Project Start Date",
          "type": "COLUMN",
          "columnId": 203,
          "column": {
            "id": 203,
            "name": "Project Start Date",
            "type": "TEXT",
            "multiple": false,
            "isRequired": true,
            "isReadOnly": false
          }
        }
      ]
    }
  ]
}

Retrieve a specific form template by ID, including its full field layout.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

formTemplateIdintegerRequired

Form template identifier

Response

Form template details

idinteger or null

Form template identifier

namestring or null

Template name

createdAtstring or nullformat: "date-time"

updatedAtstring or nullformat: "date-time"

assigneeobject or null

Direct user assignment. Null if assigneeProperty is used instead.

assigneePropertystring or null

Property-based assignee key. Returns a standard key (OWNER, SALES_REP, PROJECT_MANAGER, CREATED_BY) or the keyName of a custom PERSON property. Null if a direct user assignee is set.

collaboratorslist of objects or null

Direct user collaborators.

collaboratorPropertieslist of strings or null

Property-based collaborator keys. Each value is a standard key (OWNER, SALES_REP, PROJECT_MANAGER, CREATED_BY) or the keyName of a custom PERSON property.

labelslist of objects or null

dueDateXDaysAfterinteger or null

Number of days after creation that the form is due

formLayoutslist of objects or null

Top-level layout items (GROUP sections and standalone COLUMN fields). Only root-level items are returned; child items are nested inside each GROUP’s properties array.

Authentication

Path parameters

Response

Errors