FOfolk
Person enrichments

Get an enrichment of people

Changed on

Retrieve an enrichment of people, with the result for each person once it is completed.

get/v1/person-enrichments/{enrichmentId}

Request

  • Base URL
    https://api.folk.app
  • URL
    https://api.folk.app/v1/person-enrichments/{enrichmentId}
  • Auth
    HTTP bearer

Path parameters

enrichmentIdstring required

The ID of the enrichment to get.

Response

The enrichment that has been retrieved.

deprecationsstring[]

Example response

{
  "data": {
    "id": "enr_3f2a6c1e-8b1d-4f0a-9c2e-5d7b8a9e0f11",
    "status": "completed",
    "fields": [
      "emails",
      "phones"
    ],
    "createdAt": "2026-09-23T13:02:36.209Z",
    "finishedAt": "2026-09-23T13:03:25.203Z",
    "errorReason": null,
    "summary": {
      "total": 5,
      "enriched": 1,
      "partiallyEnriched": 1,
      "notEnriched": 1,
      "skipped": 1,
      "error": 1
    },
    "items": [
      {
        "id": "per_05834d3b-2c1a-4e5f-8a9b-0c1d2e3f4a5b",
        "status": "enriched",
        "enrichedFields": [
          "emails",
          "phones"
        ],
        "missingInputs": []
      },
      {
        "id": "per_9a1c7e2f-3b4d-4c5e-9f6a-7b8c9d0e1f2a",
        "status": "partially_enriched",
        "enrichedFields": [
          "emails"
        ],
        "missingInputs": [
          "linkedinUrl"
        ]
      },
      {
        "id": "per_77be1a2b-4c5d-4e6f-8a7b-9c0d1e2f3a4b",
        "status": "not_enriched",
        "enrichedFields": [],
        "missingInputs": [
          "companyWebsite",
          "linkedinUrl"
        ]
      },
      {
        "id": "per_2d4f6a8c-1e3b-4d5f-9a7c-8e0b2d4f6a8c",
        "status": "skipped",
        "enrichedFields": [],
        "missingInputs": []
      },
      {
        "id": "per_c3e5a7b9-2d4f-4a6c-8e0b-1d3f5a7c9e0b",
        "status": "error",
        "enrichedFields": [],
        "missingInputs": []
      }
    ]
  },
  "deprecations": [
    "This field is deprecated"
  ]
}

Changes