FOfolk
Person enrichments

List enrichments of people

Changed on

Retrieve a paginated list of the person enrichments of the workspace.

get/v1/person-enrichments

Request

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

Query parameters

limitinteger

The number of enrichments to return, up to 10: each enrichment includes the result of up to 500 people.

cursorstring

A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the pagination.nextLink value returned in a previous response to request subsequent results.

combinator'and' | 'or'

The logical operator to combine multiple filters.

filterobject

A record of filters to apply, following the format filter[attribute][operator]=value. Refer to Filterable fields to learn more.

Response

A page of person enrichments of the workspace.

deprecationsstring[]

Example response

{
  "data": {
    "items": [
      {
        "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": []
          }
        ]
      }
    ],
    "pagination": {}
  },
  "deprecations": [
    "This field is deprecated"
  ]
}

Changes