E-File Magic

Help

List help topics or search guidance

Find public help, knowledge-base articles and API documentation. The documentation corpus also indexes curated common support responses with their complete current article procedures; knowledge_base searches public articles directly. Results remain bounded and customer-scoped.

GET
/api/v1/help/topics
Authentication
OAuth 2.0 access token
Required scopes
See authentication requirements
Idempotency key
Not required
Rate-limit cost
1 unit

On success, data contains the fields below. meta includes api_version and request_id. Keep request_id when reporting a problem.

Response fields

3 fields
itemsAlways returnedarray<object>

Maximum items: 100.

Nested fields (4)

idAlways returnedstring

Type: string.

purposeAlways returnedstring

Type: string.

scoreMay be omittednumber

Relative search relevance for this query, not a confidence probability; present for search results. Minimum: 0.

titleAlways returnedstring

Type: string.

limit_reachedMay be omittedboolean

Type: boolean.

total_matchesMay be omittedinteger

Minimum: 0.

Complete response schema: ApiHelpTopics

Structure · HTTP 200
{
  "data": {
    "items": "array<object>",
    "limit_reached": "boolean",
    "total_matches": "integer"
  },
  "meta": {
    "api_version": "v1",
    "request_id": "string"
  }
}

Successful response structure. This outline shows field types, not a response to copy. Expand Response fields for nested properties and optional values.