# JSON Schema and an example for each change kind. GET https://services.leadconnectorhq.com/ai-builder-api/projects/{projectId}/changes/schema Static per server release: what `change` must look like for each kind `POST /changes/plan` accepts, as JSON Schema (draft 2020-12, input shape) with one valid example. ## Authentication Send `Authorization: Bearer ` using: - **Sub-Account token: OAuth access token or Private Integration Token.** Scopes: `clientportal-ai.readonly` ## Parameters ### Header Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `Version` | string | Yes | The API version. | ### Path Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `projectId` | string | Yes | The project's id. | ### Query Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `kind` | string | No | One kind; absent returns every supported kind. | ## OpenAPI Specification ```json { "openapi": "3.0.0", "info": { "title": "HighLevel API", "version": "v3" }, "servers": [ { "url": "https://services.leadconnectorhq.com" } ], "paths": { "/ai-builder-api/projects/{projectId}/changes/schema": { "get": { "summary": "JSON Schema and an example for each change kind.", "operationId": "jsonSchemaAndAnExampleForEachChangeKind", "description": "Static per server release: what `change` must look like for each kind\n`POST /changes/plan` accepts, as JSON Schema (draft 2020-12, input\nshape) with one valid example.\n", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "pattern": "^prj_[A-Za-z0-9_-]+$" }, "description": "The project's id.", "example": "prj_5f0c2a3e" }, { "in": "query", "name": "kind", "required": false, "schema": { "type": "string", "pattern": "^[a-z][a-z_]{0,39}$" }, "description": "One kind; absent returns every supported kind.", "example": "modules" }, { "name": "Version", "in": "header", "required": true, "description": "The API version.", "schema": { "type": "string", "enum": [ "v3" ] } } ], "responses": { "200": { "description": "The schemas.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeSchemas" } } } }, "400": { "description": "Unsupported kind (`unsupported_change_kind`).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "No valid session." } }, "security": [ { "bearer": [ "clientportal-ai.readonly" ] } ] } } }, "components": { "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer", "description": "A sub-account access token: a Marketplace app's OAuth token or a Private Integration Token." } }, "schemas": { "ChangeSchemas": { "type": "object", "additionalProperties": false, "required": [ "kinds" ], "properties": { "kinds": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "kind", "description", "schema", "example" ], "properties": { "kind": { "type": "string", "description": "The change kind, sent as `kind` to POST …/changes/plan.", "example": "modules" }, "description": { "type": "string", "description": "What this kind changes.", "example": "Turn portal modules on or off." }, "schema": { "type": "object", "additionalProperties": true, "description": "JSON Schema (draft 2020-12) of the change.", "example": { "type": "object", "properties": { "disable": { "type": "array", "items": { "type": "string" } } } } }, "example": { "description": "A valid change of this kind.", "example": { "disable": [ "communities" ] } } } }, "description": "Every kind of change this project accepts, each with its schema.", "example": [ { "kind": "modules", "description": "Turn portal modules on or off.", "schema": { "type": "object" }, "example": { "disable": [ "communities" ] } } ] } }, "title": "ChangeSchemas" }, "ApiError": { "type": "object", "required": [ "type", "title", "status", "code", "requestId" ], "properties": { "type": { "type": "string", "format": "uri", "example": "about:blank", "description": "A URI identifying the kind of error." }, "title": { "type": "string", "example": "Request validation failed", "description": "Short summary of the kind of error." }, "status": { "type": "integer", "minimum": 400, "maximum": 599, "example": 422, "description": "The HTTP status code." }, "detail": { "type": "string", "example": "One or more fields are invalid.", "description": "What went wrong with this request." }, "instance": { "type": "string", "example": "/api/v1/runs", "description": "The request path that failed." }, "code": { "type": "string", "example": "validation_error", "description": "Stable, machine-readable error code." }, "requestId": { "type": "string", "example": "req_01HXQ8Z6J9K2", "description": "The request's id, for support." }, "fieldErrors": { "type": "array", "items": { "type": "object", "required": [ "field", "code", "message" ], "properties": { "field": { "type": "string", "example": "prompt", "description": "The invalid field, as a dotted path." }, "code": { "type": "string", "example": "required", "description": "Machine-readable reason." }, "message": { "type": "string", "example": "Prompt is required.", "description": "Human-readable reason." } }, "title": "FieldError" }, "description": "One entry per invalid field, when the request body was invalid.", "example": [ { "field": "name", "code": "too_long", "message": "name must be at most 120 characters" } ] } }, "title": "ApiError" } } } } ``` ## Code Examples **cURL** ```bash curl -L -X GET 'https://services.leadconnectorhq.com/ai-builder-api/projects//changes/schema' \ -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/ai-builder-api/projects//changes/schema', options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` **Python** ```python import requests url = "https://services.leadconnectorhq.com/ai-builder-api/projects/{projectId}/changes/schema" headers = { "Authorization": "Bearer ", "Version": "v3" } response = requests.get(url, headers=headers) print(response.json()) ``` **PHP** ```php 'https://services.leadconnectorhq.com/ai-builder-api/projects//changes/schema', 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/ai-builder-api/projects//changes/schema") .header("Authorization", "Bearer ") .header("Version", "v3") .asString(); ``` **Go** ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://services.leadconnectorhq.com/ai-builder-api/projects//changes/schema" 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/ai-builder-api/projects//changes/schema") 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/ai-builder-api/projects//changes/schema' -Method 'GET' -Headers $headers $response | ConvertTo-Json ```