Skip to main content
Helpdesk Imports

List the records of an import (default: the failed ones)

Lists the items of an import with one outcome (default failed), with the reason (error) and the Featurebase id each became. Page with cursor = the previous nextCursor.

GET
/v2/helpdesk_imports/{id}/records

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Path Parameters

idstringrequired

The import id (from POST /v2/helpdesk_imports or GET /v2/helpdesk_imports).

Pattern: ^[a-f0-9]{24}$
Example: 6720b1c2d3e4f5a6b7c8d9e0

Query Parameters

outcomeenum<string>query

Only records with this outcome: failed (default), skipped, created, updated, unchanged or mapped.

Available options: created, updated, unchanged, mapped, skipped, failed
Example: failed
limitintegerquery

Records per page, 1 to 100 (default 50).

Required range: 1 <= x <= 100
Example: 50
cursorstringquery

The nextCursor of the previous page.

Maximum string length: 512

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Example: 2026-08-19.orbit

Response

application/json

Success

dataobject[]required
nextCursorstring | nullrequired

Send it as cursor for the next page. Null: no more.

objectenum<string>required
Available options: list
Example: list

Still need help? Ask the team