Karia
ReferencesOpenapiLead settings

Get current lead settings

GET
/organisation/{orgId}/workspace/{workspaceId}/origination/lead-settings

Get the current lead settings for the specified organisation and workspace, including the default financier, product, budget, and budget size used when generating an estimate.

Authorization

ApiKeyAuth
x-api-key<token>

API key for authentication

In: header

Path Parameters

workspaceId*integer
Range0 < value <= 9007199254740991
orgId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/organisation/string/workspace/1/origination/lead-settings"
{  "id": "string",  "isEnabled": true,  "defaultFinancierId": 1,  "defaultFinancierProductId": 1,  "defaultBudgetId": 1,  "defaultBudgetSize": "string",  "matchWindowInDays": -9007199254740991,  "defaultAssignees": [    "string"  ],  "createdAt": "string",  "createdBy": "string",  "lastUpdatedAt": "string",  "lastUpdatedBy": "string"}

List budget options GET

List budgets and their sizes, including annual kilometres, used when generating an estimate in the specified organisation and workspace.

List financier options GET

List financiers available when generating an estimate in the specified organisation and workspace.