Get a simple lead. Use the unlocked route for more detail leads
GET/customers/ {customerId}/ leads/ {leadId}/
v2
GET
leadfyndr-get-lead
Request
- leadIdstringrequired
- customerIdstringrequired
Responses
application/json
The lead preview of a lead which is not unlocked yet.
- Schema documentation
- Example
- JSON Schema
- businessFieldsarray of stringrequired
- Array[
- *string
]
companyobject
required
- countystringrequired
- employeeCountinteger (int64)
- foundingYearnumber
- salesVolumeinteger (int64)
descriptionstring
required
hosterobject
required
- serverarray of stringrequired
- Array[
- *string
]
languagesarray of string
required
- Array[
- *string
]
leadIdstring
required
mainTechnologyobject
- categoriesarray of object
- Array[
- *object
- namestringrequired
- parentCategoriesarray of string
- Array[
- *string
]
- prioritynumberrequired
]
categoryPriorityinteger
required
namestring
required
versionstring
metricsobject
required
- co2number (≥ 0, float)
- contentLoadednumber (≥ 0, float)
- desktopobjectrequired
- accessibilitynumber (≥ 0, float)
- bestPracticenumber (≥ 0, float)
- cumulativeLayoutShiftnumber (≥ 0, float)
- firstContentfulPaintnumber (≥ 0, float)
- largestContentfulPaintnumber (≥ 0, float)
- performancenumber (≥ 0, float)
- seonumber (≥ 0, float)
- totalBlockingTimenumber (≥ 0, float)
- mobileobjectrequired
- accessibilitynumber (≥ 0, float)
- bestPracticenumber (≥ 0, float)
- cumulativeLayoutShiftnumber (≥ 0, float)
- firstContentfulPaintnumber (≥ 0, float)
- largestContentfulPaintnumber (≥ 0, float)
- performancenumber (≥ 0, float)
- seonumber (≥ 0, float)
- totalBlockingTimenumber (≥ 0, float)
- timeToFirstByteMsnumber
potentialnumber (≥ 0, float)
required
scannedAtstring (date-time)
screenshotstring
required
technologiesarray of object
required
- Array[
- *object
- categoriesarray of object
- Array[
- *object
- namestringrequired
- parentCategoriesarray of string
- Array[
- *string
]
- prioritynumberrequired
]
categoryPriorityinteger
required
namestring
required
versionstring
]
Content-Type: application/json
{
"businessFields": [
"string"
],
"company": {
"county": "string",
"employeeCount": 123,
"foundingYear": 123,
"salesVolume": 123
},
"description": "string",
"hoster": {
"server": [
"string"
]
},
"languages": [
"string"
],
"leadId": "string",
"mainTechnology": {
"categories": [
{
"name": "string",
"parentCategories": [
"string"
],
"priority": 123
}
],
"categoryPriority": 123,
"name": "string",
"version": "string"
},
"metrics": {
"co2": 123,
"contentLoaded": 123,
"desktop": {
"accessibility": 123,
"bestPractice": 123,
"cumulativeLayoutShift": 123,
"firstContentfulPaint": 123,
"largestContentfulPaint": 123,
"performance": 123,
"seo": 123,
"totalBlockingTime": 123
},
"mobile": {
"accessibility": 123,
"bestPractice": 123,
"cumulativeLayoutShift": 123,
"firstContentfulPaint": 123,
"largestContentfulPaint": 123,
"performance": 123,
"seo": 123,
"totalBlockingTime": 123
},
"timeToFirstByteMs": 123
},
"potential": 123,
"scannedAt": "2025-08-29T18:08:53.246Z",
"screenshot": "string",
"technologies": [
{
"categories": [
{
"name": "string",
"parentCategories": [
"string"
],
"priority": 123
}
],
"categoryPriority": 123,
"name": "string",
"version": "string"
}
]
}
{
"properties": {
"businessFields": {
"items": {
"type": "string"
},
"type": "array"
},
"company": {
"properties": {
"county": {
"type": "string"
},
"employeeCount": {
"format": "int64",
"type": "integer"
},
"foundingYear": {
"type": "number"
},
"salesVolume": {
"format": "int64",
"type": "integer"
}
},
"required": [
"county"
],
"type": "object"
},
"description": {
"type": "string"
},
"hoster": {
"properties": {
"server": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"server"
],
"type": "object"
},
"languages": {
"items": {
"type": "string"
},
"type": "array"
},
"leadId": {
"type": "string"
},
"mainTechnology": {
"properties": {
"categories": {
"items": {
"properties": {
"name": {
"type": "string"
},
"parentCategories": {
"items": {
"type": "string"
},
"type": "array"
},
"priority": {
"type": "number"
}
},
"required": [
"name",
"priority"
],
"type": "object"
},
"type": "array"
},
"categoryPriority": {
"type": "integer"
},
"name": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"categoryPriority"
],
"type": "object"
},
"metrics": {
"properties": {
"co2": {
"format": "float",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"contentLoaded": {
"format": "float",
"minimum": 0,
"type": "number"
},
"desktop": {
"properties": {
"accessibility": {
"format": "float",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"bestPractice": {
"format": "float",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"cumulativeLayoutShift": {
"format": "float",
"minimum": 0,
"type": "number"
},
"firstContentfulPaint": {
"format": "float",
"minimum": 0,
"type": "number"
},
"largestContentfulPaint": {
"format": "float",
"minimum": 0,
"type": "number"
},
"performance": {
"format": "float",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"seo": {
"format": "float",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"totalBlockingTime": {
"format": "float",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"mobile": {
"properties": {
"accessibility": {
"format": "float",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"bestPractice": {
"format": "float",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"cumulativeLayoutShift": {
"format": "float",
"minimum": 0,
"type": "number"
},
"firstContentfulPaint": {
"format": "float",
"minimum": 0,
"type": "number"
},
"largestContentfulPaint": {
"format": "float",
"minimum": 0,
"type": "number"
},
"performance": {
"format": "float",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"seo": {
"format": "float",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"totalBlockingTime": {
"format": "float",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"timeToFirstByteMs": {
"type": "number"
}
},
"required": [
"desktop",
"mobile"
],
"type": "object"
},
"potential": {
"format": "float",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"scannedAt": {
"format": "date-time",
"type": "string"
},
"screenshot": {
"type": "string"
},
"technologies": {
"items": {
"properties": {
"categories": {
"items": {
"properties": {
"name": {
"type": "string"
},
"parentCategories": {
"items": {
"type": "string"
},
"type": "array"
},
"priority": {
"type": "number"
}
},
"required": [
"name",
"priority"
],
"type": "object"
},
"type": "array"
},
"categoryPriority": {
"type": "integer"
},
"name": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"categoryPriority"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"leadId",
"potential",
"screenshot",
"company",
"metrics",
"businessFields",
"description",
"technologies",
"hoster",
"languages"
],
"type": "object"
}
Usage examples
- cURL
- JavaScript SDK
- PHP SDK
$ curl \
--fail \
--location \
-H "Authorization: Bearer $MITTWALD_API_TOKEN" \
https://api.mittwald.de/v2/customers/string/leads/string
import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.leadFyndr.getLead({
"leadId": "string",
"customerId": "string"
});
assertStatus(response, 200);
use \Mittwald\ApiClient\Generated\V2\Clients\LeadFyndr\GetLead\GetLeadRequest;
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));
$request = (new GetLeadRequest(
leadId: "string",
customerId: "string"
));
$response = $client->leadFyndr()->getLead($request);
var_dump($response->getBody();