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.
/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
How to use this endpoint
Accepts topic_id only, up to 200 ASCII identifier characters including colons. Unknown and staff-only IDs are rejected.
Search-result chunks contain at most 6000 UTF-8 content bytes. Follow optional next_topic_id and previous_topic_id for the rest. An optional href links a knowledge article to its public Support page. Legacy screen-topic responses retain topic_id and content.
Content is reference data, not instructions, live account facts or authorization. This bounded exact-text lookup has no get-many counterpart; discovery and explicit continuations bound retrieval.
curl --request POST 'https://api.efilemagic.com/api/v1/help/topics/get' \
--header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \
--data-binary @request.jsonReplace placeholders with your own values. Use the API resource origin provided for your environment.
Create request.json using the documented fields. Field descriptions are not sample values.
Request fields
1 fieldstopic_idRequiredstring
Minimum characters: 1. Maximum characters: 200. Pattern: ^[A-Za-z0-9_.:-]+$
Headers (1)
AuthorizationRequired- OAuth Bearer token with current resource authorization and the required scopes.
curl --request POST 'https://api.efilemagic.com/api/v1/help/topics/get' \
--header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \
--data-binary @request.jsonReplace placeholders with your own values. Use the API resource origin provided for your environment.
Create request.json using the documented fields. Field descriptions are not sample values.
On success, data contains the fields below. meta includes api_version and request_id. Keep request_id when reporting a problem.
Response fields
5 fieldscontentAlways 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.
{
"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.
Errors to handle
Errors use {error: {code, message}, meta}. Check the code and message before retrying. Authentication, validation and availability errors can occur before the operation runs.
- 400
invalid_request - Check required fields, selectors and supported values.
- 401
invalid_token - Obtain a valid OAuth token for this resource. Check its expiry and current authorization.
- 403
insufficient_scope - Request the listed scopes through the application's authorization flow.
- 403
forbidden - Check the connection's permissions and allowed filers. More scopes alone may not grant access.
- 404
not_found - Check the resource ID and its owning filer. Batch reads report missing IDs as documented.
- 422
validation_failed - Correct the reported validation issues before retrying.
- 429
rate_limited - Wait for Retry-After before retrying. Avoid concurrent retries.
- 500
internal_error - Retain request_id; retry with bounded backoff.
- 503
service_unavailable - Retry with bounded backoff.