View as Markdown

List Enrichments

GET/v2/enrichments

Lists the workspace enrichments, newest first: the ones created through the API and the ones created in the App. Filter by status or source; per_page up to 100. Free; a poll (0 rate-limit units, per-second window only).

Query parameters

  • pageintegeroptionalmin: 1default: 1

    The page, 1-based.

  • per_pageintegeroptionalmin: 1max: 100default: 25

    Jobs per page.

  • statusenumoptional

    Only the jobs in this status.

    Allowed values: queued sampling matching awaiting_confirmation enriching finding assembling completed failed cancelled

  • sourceenumoptional

    Only the jobs created through the API (api, JSON rows) or the App (file, a CSV upload).

    Allowed values: api file

Responses

  • 200 One page of jobs.
  • 400 Invalid query (VALIDATION_ERROR; payload.code says which kind of mistake).
  • 401 Missing, unknown or inactive credentials (UNAUTHORIZED).
  • 429 Over the poll rate limit (RATE_LIMIT); wait Retry-After seconds. Sent only where rate limits are enforced for the caller channel.
  • 500 Unexpected server error.

For error handling see Errors. Response objects are described in Person object and Company object.