Get Form Template | Coperniq API

const url = 'https://api.coperniq.io/v1/form-templates/1';
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",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "assignee": {
    "id": 1,
    "firstName": "string",
    "lastName": "string",
    "email": "string"
  },
  "assigneeProperty": "string",
  "collaborators": [
    {
      "id": 1,
      "firstName": "string",
      "lastName": "string",
      "email": "string"
    }
  ],
  "collaboratorProperties": [
    "string"
  ],
  "labels": [
    {
      "id": 1,
      "label": "string",
      "color": "string"
    }
  ],
  "dueDateXDaysAfter": 1,
  "formLayouts": [
    {
      "id": 1,
      "name": "string",
      "type": "GROUP",
      "columnId": 1,
      "column": {
        "id": 1,
        "name": "string",
        "type": "string",
        "multiple": true,
        "isRequired": true,
        "isReadOnly": true
      },
      "properties": [
        {
          "id": 1,
          "name": "string",
          "type": "COLUMN",
          "columnId": 1,
          "column": {
            "id": 1,
            "name": "string",
            "type": "string",
            "multiple": true,
            "isRequired": true,
            "isReadOnly": true
          }
        }
      ],
      "fields": [
        {
          "id": 1,
          "name": "string",
          "type": "COLUMN",
          "columnId": 1,
          "column": {
            "id": 1,
            "name": "string",
            "type": "string",
            "multiple": true,
            "isRequired": true,
            "isReadOnly": true
          }
        }
      ]
    }
  ]
}

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

Form template identifier

namestring

Template name

createdAtstringformat: "date-time"

updatedAtstringformat: "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

Direct user collaborators.

collaboratorPropertieslist of strings

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

dueDateXDaysAfterinteger or null

Number of days after creation that the form is due

formLayoutslist of objects

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.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error