---
title: "List enrichments of people"
method: GET
path: "/v1/person-enrichments"
tags: ["Person enrichments"]
---

# List enrichments of people

`GET /v1/person-enrichments`

## Request

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

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

## Query parameters

- `limit` integer
- `cursor` string
- `combinator` 'and' | 'or'
- `filter` object

## Response `200`

A page of person enrichments of the workspace.

- object
  - `data` object, required
    - `items` object[], required
      - `id` string, required: The ID of the enrichment.
      - `status` 'pending' | 'in_progress' | 'completed' | 'failed', required: The status of the enrichment. `pending`: not started yet. `in_progress`: running. `completed`: over, see `summary` and `items`. `failed`: the enrichment couldn't run, see `errorReason`. New values may be added in the future: handle unknown values gracefully.
      - `fields` string[], required: The requested fields. New values may be added in the future: handle unknown values gracefully.
      - `createdAt` string, date-time, required: When the enrichment was requested.
      - `finishedAt` string, date-time, nullable, required: When the enrichment completed or failed, or null while it is pending or in progress.
      - `errorReason` 'insufficient_credits' | 'internal_error' | 'null', nullable, required: Why the enrichment failed, or null if it didn't. `insufficient_credits`: the workspace ran out of enrichment credits before the enrichment started. `internal_error`: a technical failure. New values may be added in the future: handle unknown values gracefully.
      - `summary` object, nullable, required: Counts of people per result status, among the people you can access. Null until the enrichment is completed.
        - `total` integer, required: The number of distinct people in the enrichment that you can access.
        - `enriched` integer, required: The number of people with the `enriched` status.
        - `partiallyEnriched` integer, required: The number of people with the `partially_enriched` status.
        - `notEnriched` integer, required: The number of people with the `not_enriched` status.
        - `skipped` integer, required: The number of people with the `skipped` status.
        - `error` integer, required: The number of people with the `error` status.
      - `items` object[], nullable, required: The result for each person you can access, all in this response (not paginated). Null until the enrichment is completed.
        - `id` string, required: The ID of the person. If a requested ID belonged to a person already merged into another one, this is the ID of the resulting person. For the `skipped` status, this is the ID as sent.
        - `status` 'enriched' | 'partially_enriched' | 'not_enriched' | 'skipped' | 'error', required: The enrichment result for this person. `enriched`: new data was found for every requested field. `partially_enriched`: new data was found for some requested fields, see `enrichedFields`. `not_enriched`: the person was searched, and no new data was found for the requested fields. A value the person already had doesn't count. `skipped`: the ID doesn't match a person you can enrich (unknown, deleted or not editable by you), so the person wasn't searched. `error`: no enrichment provider could process this person, for instance because the providers were unavailable, so the person wasn't searched. Request a new enrichment for this person later. New values may be added in the future: handle unknown values gracefully.
        - `enrichedFields` string[], required: The requested fields for which an enrichment provider found data during this enrichment. Empty unless the status is `enriched` or `partially_enriched`. New values may be added in the future: handle unknown values gracefully.
        - `missingInputs` string[], required: The person data the enrichment providers search with, that the person didn't have when searched. Adding it to the person may improve the results of a new enrichment, with no guarantee. `name`: a first or last name. `company`: a company linked to the person. `companyWebsite`: a website on the primary company of the person. `linkedinUrl`: a LinkedIn profile URL (`https://www.linkedin.com/in/...`) in the URLs of the person. Empty unless the status is `not_enriched` or `partially_enriched`. New values may be added in the future: handle unknown values gracefully.
    - `pagination` object, required
      - `nextLink` string
  - `deprecations` string[]

## Other responses

- `400`: The request was unacceptable, often due to missing an invalid parameter.
- `401`: No valid API key provided.
- `403`: The API key doesn’t have permissions to perform the request.
- `404`: The requested resource doesn’t exist.
- `422`: The request was unacceptable, often due to missing or invalid parameters.
- `429`: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
- `500`: Something went wrong on our end.
- `503`: The server is overloaded or down for maintenance.

## Changes

- **2026-11-03** `c6818f3ba60d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/folk/apis/folk-external-api/changes/v1/person-enrichments/get.md)

---

[API](https://skmtc.dev/folk/apis/folk-external-api.md) - [All operations](https://skmtc.dev/folk/apis/folk-external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/folk/apis/folk-external-api/revisions/c6818f3ba60d?raw)