Helpdesk Imports

List imports

Lists the 50 newest imports of the workspace, newest first, with their status, progress and nextStep.

GET

/v2/helpdesk_imports

List imports

curl --request GET \
  --url https://do.featurebase.app/v2/helpdesk_imports \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-08-19.orbit'

{
  "data": [
    {
      "account": {
        "connectedAs": "jane@acme.com",
        "conversationAccess": "all",
        "domain": "acme.freshdesk.com",
        "name": "Acme"
      },
      "companyMatch": {
        "by": "company_id",
        "fieldKey": "<string>"
      },
      "continues": {
        "importId": "<string>",
        "since": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": {
        "id": "<string>",
        "name": "<string>"
      },
      "expiresAt": "2026-11-02T12:00:00.000Z",
      "fields": {
        "counted": {
          "company": 123,
          "contact": 123,
          "conversation": 123
        },
        "editable": true,
        "mapped": {
          "company": 123,
          "contact": 123,
          "conversation": 123
        }
      },
      "finishedAt": "2026-11-02T12:00:00.000Z",
      "id": "6720b1c2d3e4f5a6b7c8d9e0",
      "lastError": {
        "at": "<string>",
        "code": "<string>",
        "message": "<string>",
        "stream": "<string>"
      },
      "mapping": {
        "agents": {},
        "brands": {},
        "teams": {}
      },
      "nextStep": {
        "description": "Everything was read. Check the fields (GET /v2/helpdesk_imports/{id}/fields), then start the import (POST /v2/helpdesk_imports/{id}/start).",
        "step": "map_fields"
      },
      "object": "helpdesk_import",
      "options": {
        "conversationsSince": "<string>",
        "importAttachments": true,
        "openConversations": "close",
        "snoozedConversations": "open",
        "streams": [
          "agents"
        ],
        "syncContactsToCrm": true
      },
      "phase": "pull",
      "pull": [
        {
          "counts": {
            "failed": 0,
            "files": 0,
            "filesMissed": 0,
            "listed": 0,
            "messages": 0,
            "pulled": 0,
            "skipped": 0,
            "unchanged": 0
          },
          "endedEarly": {
            "code": "<string>",
            "message": "<string>"

Authorizations

Authorizationstringheaderrequired

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

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

Success

dataobject[]required

The 50 newest imports, newest first.

Show child attributes

objectenum<string>required

Available options: list

Example: list

Still need help? Ask the team