Skip to main content

Get all unlocked leads. Organisation can unlock leads

GET/customers/{customerId}/unlocked-leads/
v2
GET
leadfyndr-list-unlocked-leads

Request​

  • customerIdstring
    required

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.

  • leadsarray of object
    required
    • Array[
    • *object
      • actualUrlstring
        required
      • businessFieldsarray of string
        required
        • Array[
        • *string
          • ]
    • company
      required
    • contactobject
      required
      • addressobject
        • address_prefixstring
        • citystring (≥ 1 characters)
        • country_codestring (≥ 2 characters, ≤ 2 characters)
        • house_numberstring (≥ 1 characters)
        • streetstring (≥ 1 characters)
        • zipstring (≥ 1 characters)
    • descriptionstring
      required
    • domainstring
      required
    • hosterobject
      required
      • mailServerarray of string
        required
        • Array[
        • *string
          • ]
    • nameServerarray of string
      required
      • Array[
      • *string
        • ]
  • serverarray of string
    required
    • Array[
    • *string
      • ]
  • languagesarray of string
    required
    • Array[
    • *string
      • ]
  • leadIdstring
    required
  • mainTechnologyobject
    • categoriesarray of object
      • Array[
      • *object
        • namestring
          required
        • parentCategoriesarray of string
          • Array[
          • *string
            • ]
      • prioritynumber
        required
      • ]
  • categoryPriorityinteger
    required
  • namestring
    required
  • versionstring
  • metricsobject
    required
    • additionalMetricsobject
      • *object
        • categorystring
          required
        • namestring
          required
        • scorenumber
        • unitstring
        • valuenumber
    • basicobject
      required
      • co2number (≥ 0, float)
      • contentLoadednumber (≥ 0, float)
      • desktopobject
        required
        • accessibilitynumber (≥ 0, float)
        • bestPracticenumber (≥ 0, float)
        • cumulativeLayoutShiftnumber (≥ 0, float)
        • firstContentfulPaintnumber (≥ 0, float)
        • largestContentfulPaintnumber (≥ 0, float)
        • performancenumber (≥ 0, float)
        • seonumber (≥ 0, float)
        • totalBlockingTimenumber (≥ 0, float)
      • mobileobject
        required
        • 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
      • networkstring
        required
      • urlstring
        required
      • ]
  • technologiesarray of object
    required
    • Array[
    • *object
      • categoriesarray of object
        • Array[
        • *object
          • namestring
            required
          • parentCategoriesarray of string
            • Array[
            • *string
              • ]
        • prioritynumber
          required
        • ]
  • categoryPriorityinteger
    required
  • namestring
    required
  • versionstring
    • ]
  • unlockedAtstring (date-time)
    required
    • ]
  • limitnumber
    required
  • skipnumber
    required
  • totalCountnumber
    required

    • Usage examples​

    $ 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