E-File Magic

Help

Read a public help topic or guidance chunk

Read product guidance for an exact ID returned by help topic listing or search, including common support responses. Follow next_id for remaining content; an article link identifies the current public guidance, not an account action or filing result.

POST
/api/v1/help/topics/get
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

5 fields
contentAlways returnedstring

Type: string.

hrefMay be omittedstring | null

Type: string | null.

next_topic_idMay be omittedstring | null

Type: string | null.

previous_topic_idMay be omittedstring | null

Type: string | null.

topic_idAlways returnedstring

Type: string.

Complete response schema: ApiHelpTopic

Structure · HTTP 200
{
  "data": {
    "content": "string",
    "href": "string | null",
    "next_topic_id": "string | null",
    "previous_topic_id": "string | null",
    "topic_id": "string"
  },
  "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.