# Get Object Schema by key / id GET https://services.leadconnectorhq.com/objects/{key} Retrieve Object Schema by key or ID. This will return the schema of the custom object, including all its fields and properties. Supported objects include contact, opportunity, business and custom objects.To understand objects and records, please have a look the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0 ## Authentication Send `Authorization: Bearer ` using: - **Sub-Account token: OAuth access token or Private Integration Token.** Scopes: `objects/schema.readonly` ## Parameters ### Header Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `Version` | string | Yes | API Version | ### Path Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `key` | string | Yes | key of the custom or standard object. For custom objects, the key must include the prefix “custom_objects.”. This key can be found on the Object Details page under Settings in the UI. | ### Query Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `locationId` | string | Yes | location id of the sub account | | `fetchProperties` | string | No | Fetch Properties , Fetches all the standard / custom fields of the object when set to true | ## OpenAPI Specification ```json { "openapi": "3.0.0", "info": { "title": "LeadConnector API", "version": "v3" }, "servers": [ { "url": "https://services.leadconnectorhq.com" } ], "paths": { "/objects/{key}": { "get": { "summary": "Get Object Schema by key / id", "operationId": "getObjectSchemaByKeyId", "description": "Retrieve Object Schema by key or ID. This will return the schema of the custom object, including all its fields and properties. Supported objects include contact, opportunity, business and custom objects.To understand objects and records, please have a look the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0", "parameters": [ { "name": "Version", "in": "header", "description": "API Version", "required": true, "schema": { "type": "string", "enum": [ "v3" ] } }, { "name": "key", "required": true, "in": "path", "description": "key of the custom or standard object. For custom objects, the key must include the prefix “custom_objects.”. This key can be found on the Object Details page under Settings in the UI.", "schema": { "example": "custom_objects.pet", "type": "string" } }, { "name": "locationId", "required": true, "in": "query", "description": "location id of the sub account", "schema": { "example": "632c34b4c9b7da3358ac9891", "type": "string" } }, { "name": "fetchProperties", "required": false, "in": "query", "description": "Fetch Properties , Fetches all the standard / custom fields of the object when set to true", "schema": { "example": true, "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomObjectByIdResponseDTO" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestDTO" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedDTO" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableDTO" } } } } }, "security": [ { "bearer": [ "objects/schema.readonly" ] } ] } } }, "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account.", "type": "http" }, "Agency-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.", "type": "http" } }, "schemas": { "CustomObjectByIdResponseDTO": { "type": "object", "properties": { "object": { "type": "object", "properties": { "id": { "type": "string", "example": "661c06b4ffde146bdb469442", "description": "id of the custom / standard object schema" }, "standard": { "type": "boolean", "example": false, "description": "false in case of custom objects and true in case of standard objects like contacts and opportunities " }, "key": { "type": "string", "example": "custom_objects.pet", "description": "key that would be used to refer the custom / standard Object internally (lowercase + underscore_separated). For custom objects, 'custom_objects.' would be added as prefix by default" }, "labels": { "example": { "singular": "Pet", "plural": "Pets" }, "description": "This is what your custom / standard object will be called. These labels will be used to display your custom object on the UI", "allOf": [ { "type": "object", "properties": { "singular": { "type": "string", "example": "Pet", "description": "Singular name of the custom object" }, "plural": { "type": "string", "example": "Pets", "description": "Plural name of the custom object" } }, "required": [ "singular", "plural" ], "title": "CustomObjectLabelDto" } ] }, "description": { "type": "string", "example": "These are non vaccinated pets", "description": "Custom / Standard Object Descriptions for example , Pet Object`s description" }, "locationId": { "type": "string", "description": "location's id", "example": "Q9DT3OAqEXDLYuob1G32" }, "primaryDisplayProperty": { "type": "string", "description": "Primary property for the custom / standard Object. This would be used as primary data when rendering the UI. 'custom_objects.{{object_key}} or business.{{object_key}} (for company)' would be added as prefix by default for all the custom / standard objects", "example": "custom_objects.pet.name" }, "dateAdded": { "type": "string", "description": "Date and time when the object was added", "format": "date-time" }, "dateUpdated": { "type": "string", "description": "Date and time when the object was last updated", "format": "date-time" }, "type": { "type": "object", "example": "The Object type can either USER_DEFINED or SYSTEM_DEFINED", "description": "Object`s Type" } }, "required": [ "id", "standard", "key", "labels", "locationId", "primaryDisplayProperty", "dateAdded", "dateUpdated" ], "title": "ICustomObjectSchema" }, "cache": { "type": "boolean", "description": "Is the response served from cache", "example": true }, "fields": { "type": "array", "items": { "type": "object", "properties": { "locationId": { "type": "string", "description": "Location Id", "example": "ve9EPM428h8vShlRW1KT" }, "name": { "type": "string", "description": "Field name", "example": "Name" }, "description": { "type": "string", "description": "Description of the field" }, "placeholder": { "type": "string", "description": "Placeholder text for the field" }, "showInForms": { "type": "boolean", "description": "Whether the field should be shown in forms" }, "options": { "description": "Options for the field (Optional, valid only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST type)", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Key of the option (Included in Create and Response, excluded in Update)" }, "label": { "type": "string", "description": "Value of the option" }, "url": { "type": "string", "description": "URL associated with the option (Optional, valid only for RADIO type)" } }, "required": [ "key", "label" ], "title": "OptionDTO" } }, "acceptedFormats": { "type": "string", "enum": [ ".pdf", ".docx", ".doc", ".jpg", ".jpeg", ".png", ".gif", ".csv", ".xlsx", ".xls", "all" ], "description": "Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all" }, "id": { "type": "string", "description": "Unique identifier of the object" }, "objectKey": { "type": "string", "description": "The key for your custom / standard object. This key uniquely identifies the custom object. Example: \"custom_object.pet\" for a custom object related to pets.", "example": "custom_object.pet" }, "dataType": { "type": "string", "enum": [ "TEXT", "LARGE_TEXT", "NUMERICAL", "PHONE", "MONETORY", "CHECKBOX", "SINGLE_OPTIONS", "MULTIPLE_OPTIONS", "DATE", "TEXTBOX_LIST", "FILE_UPLOAD", "RADIO" ], "description": "Type of field that you are trying to create" }, "parentId": { "type": "string", "description": "ID of the parent folder", "example": "3v34PM428h8vShlRW1KT" }, "fieldKey": { "type": "string", "description": "Field key. For Custom Object it's formatted as \"custom_object.{objectKey}.{fieldKey}\". \"custom_object\" is a fixed prefix, \"{objectKey}\" is your custom object's identifier, and \"{fieldName}\" is the unique field name within that object. Example: \"custom_object.pet.name\" for a \"name\" field in a \"pet\" custom object.", "example": "custom_object.pet.name" }, "allowCustomOption": { "type": "boolean", "description": "Determines if users can add a custom option value different from the predefined options in records for RADIO type fields. A custom value added in one record does not automatically become an option and will not appear as an option for other records.", "example": true }, "maxFileLimit": { "type": "number", "description": "Maximum file limit for uploads", "example": 2 }, "dateAdded": { "type": "string", "description": "Date and time when the object was added", "format": "date-time" }, "dateUpdated": { "type": "string", "description": "Date and time when the object was last updated", "format": "date-time" } }, "required": [ "locationId", "showInForms", "id", "objectKey", "dataType", "parentId", "fieldKey", "dateAdded", "dateUpdated" ], "title": "ICustomField" } } }, "required": [ "cache" ], "title": "CustomObjectByIdResponseDTO" }, "BadRequestDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "message": { "type": "string", "example": "Bad Request" } }, "title": "BadRequestDTO" }, "UnauthorizedDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "message": { "type": "string", "example": "Invalid token: access token is invalid" }, "error": { "type": "string", "example": "Unauthorized" } }, "title": "UnauthorizedDTO" }, "UnprocessableDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 422 }, "message": { "example": [ "Unprocessable Entity" ], "type": "array", "items": { "type": "string" } }, "error": { "type": "string", "example": "Unprocessable Entity" } }, "title": "UnprocessableDTO" } } } } ``` ## Code Examples **cURL** ```bash curl -L -X GET 'https://services.leadconnectorhq.com/objects/?locationId=' \ -H 'Authorization: Bearer ' \ -H 'Version: v3' ``` **Node.js** ```javascript const options = { method: 'GET', headers: { Authorization: 'Bearer ', Version: 'v3' } }; try { const response = await fetch('https://services.leadconnectorhq.com/objects/?locationId=', options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` **Python** ```python import requests url = "https://services.leadconnectorhq.com/objects/{key}" headers = { "Authorization": "Bearer ", "Version": "v3" } params = { "locationId": "" } response = requests.get(url, params=params, headers=headers) print(response.json()) ``` **PHP** ```php 'https://services.leadconnectorhq.com/objects/?locationId=', CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ', 'Version: v3', ], ]); $response = curl_exec($curl); curl_close($curl); echo $response; ``` **Java** ```java HttpResponse response = Unirest .get("https://services.leadconnectorhq.com/objects/?locationId=") .header("Authorization", "Bearer ") .header("Version", "v3") .asString(); ``` **Go** ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://services.leadconnectorhq.com/objects/?locationId=" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Version", "v3") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) } ``` **Ruby** ```ruby require 'uri' require 'net/http' url = URI("https://services.leadconnectorhq.com/objects/?locationId=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = "Bearer " request["Version"] = "v3" response = http.request(request) puts response.read_body ``` **PowerShell** ```powershell $headers = @{ "Authorization" = "Bearer " "Version" = "v3" } $response = Invoke-RestMethod -Uri 'https://services.leadconnectorhq.com/objects/?locationId=' -Method 'GET' -Headers $headers $response | ConvertTo-Json ```