Properties

List enriched properties for the current user

getapi.modelmatch.com/v1/properties/enrichments

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Query parameters

limitinteger

Maximum number of items to return (default 25)

cursorstring

Pagination cursor from a previous response

propertyIdstring

Return only this property's enrichment (zero or one item). The id is the one in the credit ledger's enrich:<propertyId> reason.

Responses

200objectPaginated list of enriched properties

Show attributes

cursorstring

dataobject[]required

Show child attributes

chargedboolean | nullrequired

Whether the call that produced the current result debited credits. null for results stored before charges were recorded.

chargesobject[] | nullrequired

Every recorded debit for this property, oldest first. More than one means it was paid for more than once (a refresh re-run). null when not recorded.

Show child attributes

atstringrequired

ISO 8601 time of the debit

creditsnumberrequired

refreshbooleanrequired

True when this charge came from a forced re-run

creditsChargednumber | nullrequired

Total credits debited for this property across every recorded run, including forced re-runs. null when not recorded.

emailCountnumberrequired

Email addresses found across every matched person.

enrichedAtstringrequired

personCountnumberrequired

phoneCountnumberrequired

Phone numbers found across every matched person. A matched person can have none.

propertyIdstringrequired

sourcestringrequired

401objectAuthentication required

curl -X GET "https://api.modelmatch.com/v1/properties/enrichments" \
  -H "x-api-key: $MODEL_MATCH_API_KEY"

import { createClient } from "@model-match/api";

const client = createClient({ apiKey: process.env.MODEL_MATCH_API_KEY });

const { data, error } = await client.properties.listEnrichments();

import os
import requests

res = requests.get(
    "https://api.modelmatch.com/v1/properties/enrichments",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
)
data = res.json()

200 response

{
  "cursor": "<string>",
  "data": [
    {
      "charged": true,
      "charges": [
        {
          "at": "<string>",
          "credits": 123.45,
          "refresh": true
        }
      ],
      "creditsCharged": 123.45,
      "emailCount": 123.45,
      "enrichedAt": "<string>",
      "personCount": 123.45,
      "phoneCount": 123.45,
      "propertyId": "<string>",
      "source": "<string>"
    }
  ]
}