Get all unlocked leads. Organisation can unlock leads
GET/customers/ {customerId}/ unlocked-leads/
v2
GET
leadfyndr-list-unlocked-leads
Request
- customerIdstringrequired
Responses
Response headers
- X-Pagination-Limitinteger
The limit used to select the resources for the response
- X-Pagination-Skipinteger
The number of skipped items
- X-Pagination-Pagenumber
The calculate page of the list response. Refer to parameters to learn more.
- X-Pagination-TotalCountinteger
The total amount of items available in the remote ressource. Use this value in combination with the limit to calculate the available pages.
application/json
The unlocked leads list.
- Schema documentation
- Example
- JSON Schema
- leadsarray of objectrequired
- Array[
- *object
- actualUrlstringrequired
- businessFieldsarray of stringrequired
- Array[
- *string
]
- companyrequired
- contactobjectrequired
- addressobject
- address_prefixstring
- citystring (≥ 1 characters)
- country_codestring (≥ 2 characters, ≤ 2 characters)
- house_numberstring (≥ 1 characters)
- streetstring (≥ 1 characters)
- zipstring (≥ 1 characters)
- descriptionstringrequired
- domainstringrequired
- hosterobjectrequired
- mailServerarray of stringrequired
- Array[
- *string
]
- nameServerarray of stringrequired
- Array[
- *string
]
- 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
- additionalMetricsobject
- *object
- categorystringrequired
- namestringrequired
- scorenumber
- unitstring
- valuenumber
- basicobjectrequired
- 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
reservationAllowedboolean
reservedAtstring (date-time)
scannedAtstring (date-time)
screenshotstring
required
socialMediaarray of object
required
- Array[
- *object
- networkstringrequired
- urlstringrequired
]
technologiesarray of object
required
- Array[
- *object
- categoriesarray of object
- Array[
- *object
- namestringrequired
- parentCategoriesarray of string
- Array[
- *string
]
- prioritynumberrequired
]
categoryPriorityinteger
required
namestring
required
versionstring
]
unlockedAtstring (date-time)
required
]
limitnumber
required
skipnumber
required
totalCountnumber
required
Content-Type: application/json
{
"leads": [
{
"actualUrl": "string",
"businessFields": [
"string"
],
"company": null,
"contact": {
"address": {
"address_prefix": "string",
"city": "string",
"country_code": "string",
"house_number": "string",
"street": "string",
"zip": "string"
}
},
"description": "string",
"domain": "string",
"hoster": {
"mailServer": [
"string"
],
"nameServer": [
"string"
],
"server": [
"string"
]
},
"languages": [
"string"
],
"leadId": "string",
"mainTechnology": {
"categories": [
{
"name": "string",
"parentCategories": [
"string"
],
"priority": 123
}
],
"categoryPriority": 123,
"name": "string",
"version": "string"
},
"metrics": {
"additionalMetrics": {
"string": {
"category": "string",
"name": "string",
"score": 123,
"unit": "string",
"value": 123
}
},
"basic": {
"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,
"reservationAllowed": true,
"reservedAt": "2025-08-29T18:08:53.697Z",
"scannedAt": "2025-08-29T18:08:53.697Z",
"screenshot": "string",
"socialMedia": [
{
"network": "string",
"url": "string"
}
],
"technologies": [
{
"categories": [
{
"name": "string",
"parentCategories": [
"string"
],
"priority": 123
}
],
"categoryPriority": 123,
"name": "string",
"version": "string"
}
],
"unlockedAt": "2025-08-29T18:08:53.697Z"
}
],
"limit": 123,
"skip": 123,
"totalCount": 123
}
{
"properties": {
"leads": {
"items": {
"properties": {
"actualUrl": {
"type": "string"
},
"businessFields": {
"items": {
"type": "string"
},
"type": "array"
},
"company": {
"allOf": [
{
"properties": {
"county": {
"type": "string"
},
"employeeCount": {
"format": "int64",
"type": "integer"
},
"foundingYear": {
"type": "number"
},
"salesVolume": {
"format": "int64",
"type": "integer"
}
},
"required": [
"county"
],
"type": "object"
},
{
"properties": {
"city": {
"type": "string"
},
"companyType": {
"items": {
"type": "string"
},
"type": "array"
},
"coreProduct": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"targetGroup": {
"items": {
"type": "string"
},
"type": "array"
},
"websiteType": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"targetGroup",
"coreProduct",
"websiteType",
"companyType",
"city"
],
"type": "object"
}
]
},
"contact": {
"properties": {
"address": {
"properties": {
"address_prefix": {
"type": "string"
},
"city": {
"minLength": 1,
"type": "string"
},
"country_code": {
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"house_number": {
"minLength": 1,
"type": "string"
},
"street": {
"minLength": 1,
"type": "string"
},
"zip": {
"minLength": 1,
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": {
"type": "string"
},
"domain": {
"type": "string"
},
"hoster": {
"properties": {
"mailServer": {
"items": {
"type": "string"
},
"type": "array"
},
"nameServer": {
"items": {
"type": "string"
},
"type": "array"
},
"server": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"server",
"nameServer",
"mailServer"
],
"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": {
"additionalMetrics": {
"additionalProperties": {
"properties": {
"category": {
"type": "string"
},
"name": {
"type": "string"
},
"score": {
"type": "number"
},
"unit": {
"type": "string"
},
"value": {
"type": "number"
}
},
"required": [
"category",
"name"
],
"type": "object"
},
"type": "object"
},
"basic": {
"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"
}
},
"required": [
"basic"
],
"type": "object"
},
"potential": {
"format": "float",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"reservationAllowed": {
"type": "boolean"
},
"reservedAt": {
"format": "date-time",
"type": "string"
},
"scannedAt": {
"format": "date-time",
"type": "string"
},
"screenshot": {
"type": "string"
},
"socialMedia": {
"items": {
"properties": {
"network": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"network",
"url"
],
"type": "object"
},
"type": "array"
},
"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"
},
"unlockedAt": {
"format": "date-time",
"type": "string"
}
},
"required": [
"leadId",
"potential",
"screenshot",
"company",
"metrics",
"businessFields",
"description",
"technologies",
"domain",
"actualUrl",
"socialMedia",
"contact",
"hoster",
"unlockedAt",
"languages"
],
"type": "object"
},
"type": "array"
},
"limit": {
"type": "number"
},
"skip": {
"type": "number"
},
"totalCount": {
"type": "number"
}
},
"required": [
"leads",
"totalCount",
"skip",
"limit"
],
"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/unlocked-leads?potentialRangeMin=123&potentialRangeMax=123&employeeCountMin=123&employeeCountMax=123&salesVolumeMin=123&salesVolumeMax=123&technologies=string&businessFields=string&locationCity=string&locationPostCode=string&locationRadiusInKm=123&basic%3AtimeToFirstByteMs%3Amin=123&basic%3AtimeToFirstByteMs%3Amax=123&basic%3Adesktop%3Aperformance%3Amin=123&basic%3Adesktop%3Aperformance%3Amax=123&basic%3Amobile%3Aperformance%3Amin=123&basic%3Amobile%3Aperformance%3Amax=123&reserved=true&limit=50&page=1&sort=potential&order=asc
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.listUnlockedLeads({
"customerId": "string",
"queryParameters": {
"potentialRangeMin": 123,
"potentialRangeMax": 123,
"employeeCountMin": 123,
"employeeCountMax": 123,
"salesVolumeMin": 123,
"salesVolumeMax": 123,
"technologies": [
"string"
],
"businessFields": [
"string"
],
"locationCity": "string",
"locationPostCode": "string",
"locationRadiusInKm": 123,
"basic:timeToFirstByteMs:min": 123,
"basic:timeToFirstByteMs:max": 123,
"basic:desktop:performance:min": 123,
"basic:desktop:performance:max": 123,
"basic:mobile:performance:min": 123,
"basic:mobile:performance:max": 123,
"reserved": true,
"limit": 50,
"page": 1,
"sort": "potential",
"order": "asc"
}
});
assertStatus(response, 200);
use \Mittwald\ApiClient\Generated\V2\Clients\LeadFyndr\ListUnlockedLeads\ListUnlockedLeadsRequest;
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));
$request = (new ListUnlockedLeadsRequest(
customerId: "string"
))
->withPotentialRangeMin(123)
->withPotentialRangeMax(123)
->withEmployeeCountMin(123)
->withEmployeeCountMax(123)
->withSalesVolumeMin(123)
->withSalesVolumeMax(123)
->withTechnologies(["string"])
->withBusinessFields(["string"])
->withLocationCity("string")
->withLocationPostCode("string")
->withLocationRadiusInKm(123)
->withBasicTimeToFirstByteMsMin(123)
->withBasicTimeToFirstByteMsMax(123)
->withBasicDesktopPerformanceMin(123)
->withBasicDesktopPerformanceMax(123)
->withBasicMobilePerformanceMin(123)
->withBasicMobilePerformanceMax(123)
->withReserved(true)
->withLimit(50)
->withPage(1)
->withSort("potential")
->withOrder("asc");
$response = $client->leadFyndr()->listUnlockedLeads($request);
var_dump($response->getBody();