> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.coperniq.io/api-reference/forms/get-form-template-by-id/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.coperniq.io/_mcp/server. # Get Form Template GET https://api.coperniq.io/v1/form-templates/{form_template_id} Retrieve a specific form template by ID, including its full field layout. Reference: https://docs.coperniq.io/api-reference/forms/get-form-template-by-id ## Authentication - `x-api-key` header (required) — API Key authentication via header ## Request ### Path parameters - `form_template_id` (integer, required) — Form template identifier ## Response ### 200 Form template details - `id` (integer, optional) — Form template identifier - `name` (string, optional) — Template name - `createdAt` (string, optional) - `updatedAt` (string, optional) - `assignee` (FormTemplateDetailAssignee, optional, nullable) — Direct user assignment. Null if assigneeProperty is used instead. - `assigneeProperty` (string, optional, nullable) — 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. - `collaborators` (list of FormTemplateDetailCollaboratorsItems, optional) — Direct user collaborators. - `collaboratorProperties` (list of string, optional) — 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. - `labels` (list of FormTemplateDetailLabelsItems, optional) - `dueDateXDaysAfter` (integer, optional, nullable) — Number of days after creation that the form is due - `formLayouts` (list of FormTemplateLayout, optional) — 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 Invalid request - `message` (string, optional) - `code` (enum, optional) - Allowed values: `NOT_FOUND` - `field` (string, optional) — Field that caused the validation error (if applicable) ### 401 Unauthorized Error Authentication failed - `message` (string, optional) - `code` (enum, optional) - Allowed values: `NOT_FOUND` ### 404 Not Found Error Resource not found - `message` (string, optional) - `code` (enum, optional) - Allowed values: `NOT_FOUND` ## Types ### FormTemplateDetailAssignee Direct user assignment. Null if assigneeProperty is used instead. - `id` (integer, optional) - `firstName` (string, optional) - `lastName` (string, optional) - `email` (string, optional) ### FormTemplateDetailCollaboratorsItems - `id` (integer, optional) - `firstName` (string, optional) - `lastName` (string, optional) - `email` (string, optional) ### FormTemplateDetailLabelsItems - `id` (integer, optional) - `label` (string, optional) - `color` (string, optional) ### FormTemplateLayout - `id` (integer, optional) — Layout row identifier - `name` (string, optional, nullable) — Group label for GROUP type, null for COLUMN type - `type` (enum, optional) — GROUP = section header containing child items in properties. COLUMN = an actual form field. - Allowed values: `GROUP`, `COLUMN` - `columnId` (integer, optional, nullable) — Column (property) identifier. Null for GROUP items. - `column` (FormTemplateLayoutColumn, optional) — Field metadata. Only present for COLUMN type. - `properties` (list of FormTemplateChildLayout, optional) — Nested child items. Populated for GROUP items (containing COLUMN children). Empty array for COLUMN items. - `fields` (list of FormTemplateChildLayout, optional, deprecated) — Deprecated alias of properties; kept for backward compatibility. Use properties instead. ### FormTemplateLayoutColumn Field metadata. Only present for COLUMN type. - `id` (integer, optional) - `name` (string, optional) - `type` (string, optional) — Field type: DROPDOWN, NUMERIC, BOOLEAN, DATE, DATETIME, TEXT, LONG_TEXT, PERSON, FILE, SEPARATOR, PROJECT, LINK, TIMERANGEDAYS - `multiple` (boolean, optional) - `isRequired` (boolean, optional) - `isReadOnly` (boolean, optional) ### FormTemplateChildLayout - `id` (integer, optional) — Layout row identifier - `name` (string, optional, nullable) - `type` (enum, optional) - Allowed values: `COLUMN` - `columnId` (integer, optional, nullable) — Column (property) identifier - `column` (FormTemplateChildLayoutColumn, optional) — Field metadata ### FormTemplateChildLayoutColumn Field metadata - `id` (integer, optional) - `name` (string, optional) - `type` (string, optional) - `multiple` (boolean, optional) - `isRequired` (boolean, optional) - `isReadOnly` (boolean, optional) ## Examples **Response** ```json { "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 } } ] } ] } ``` **SDK Code** ```python import requests url = "https://api.coperniq.io/v1/form-templates/1" headers = {"x-api-key": ""} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.coperniq.io/v1/form-templates/1'; const options = {method: 'GET', headers: {'x-api-key': ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.coperniq.io/v1/form-templates/1" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("x-api-key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.coperniq.io/v1/form-templates/1") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["x-api-key"] = '' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.coperniq.io/v1/form-templates/1") .header("x-api-key", "") .asString(); ``` ```php request('GET', 'https://api.coperniq.io/v1/form-templates/1', [ 'headers' => [ 'x-api-key' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.coperniq.io/v1/form-templates/1"); var request = new RestRequest(Method.GET); request.AddHeader("x-api-key", ""); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["x-api-key": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api.coperniq.io/v1/form-templates/1")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` > Official Coperniq API documentation. Build integrations for solar and construction project management — projects, opportunities, work orders, invoices, webhooks, and more.