Helpdesk Imports

List the source's agents, teams and brands, and what each maps to

Reads the agents, teams and (Freshdesk) products of the source account, with what each one maps to when the import runs (mapsTo): the saved choice (chosen), else the teammate with the same email, the team with the same name, the brand with the same name. It asks the source each time: do not poll it. Change them with PATCH /v2/helpdesk_imports/{id} and mapping. Also rough counts of the source and conversationsPerHour (a rough duration of the pull).

GET

/v2/helpdesk_imports/{id}/teammates

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

{
  "agents": [
    {
      "chosen": true,
      "email": "<string>",
      "externalId": "5123456",
      "mapsTo": "<string>",
      "name": "<string>"
    }
  ],
  "brands": [
    {
      "chosen": true,
      "externalId": "<string>",
      "mapsTo": "<string>",
      "name": "<string>"
    }
  ],
  "canCreateTeams": true,
  "conversationsPerHour": 1000,
  "counts": {
    "conversations": 101698
  },
  "importId": "<string>",
  "object": "helpdesk_import_teammates",
  "teams": [
    {
      "chosen": true,
      "externalId": "<string>",
      "mapsTo": "<string>",
      "name": "<string>"
    }
  ],
  "workspaceBrands": [
    {
      "id": "<string>",
      "isDefault": true,
      "name": "<string>"
    }
  ]
}

Drafts only: after the pull starts, the mapping is fixed.

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

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

agentsobject[]required

Show child attributes

brandsobject[]required

Show child attributes

canCreateTeamsbooleanrequired

The plan has support teams (new creates one).

conversationsPerHournumber

About how many conversations the pull reads per hour (with counts, a rough duration).

Example: 1000

countsobjectrequired

Rough counts in the source per stream, when the source tells them cheaply.

importIdstringrequired

objectenum<string>required

Available options: helpdesk_import_teammates

Example: helpdesk_import_teammates

teamsobject[]required

Show child attributes

workspaceBrandsobject[]required

Show child attributes

Still need help? Ask the team