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.
/api/v1/help/topics- 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
Without query, returns the existing bounded screen-topic catalog. With query (1–200 bytes), returns at most five matching chunks plus total_matches and limit_reached. Optional corpus is knowledge_base (default) or documentation and requires query.
knowledge_base searches reviewed articles published under Support. documentation searches full public guides, assistant context and API references. Authentication is required; no additional account-data scope is needed. Staff material and raw support exports are excluded.
Pass an exact returned id to the topic lookup endpoint. Narrow the query when limit_reached is true. Read the full chunk before relying on its excerpt.
curl --request GET 'https://api.efilemagic.com/api/v1/help/topics' \
--header 'Authorization: Bearer <access-token>'Replace placeholders with your own values. Use the API resource origin provided for your environment.
Request fields
2 fieldsquery.queryOptionalstring
Search keywords; omit for the screen-topic catalog. Minimum characters: 1. Maximum characters: 200.
query.corpusOptionalstring
Requires query. Defaults to knowledge_base; documentation searches public guides and API references. Allowed values: "knowledge_base", "documentation".
Headers (1)
AuthorizationRequired- OAuth Bearer token with current resource authorization and the required scopes.
curl --request GET 'https://api.efilemagic.com/api/v1/help/topics' \
--header 'Authorization: Bearer <access-token>'Replace placeholders with your own values. Use the API resource origin provided for your environment.
On success, data contains the fields below. meta includes api_version and request_id. Keep request_id when reporting a problem.
Response fields
3 fieldsitemsAlways 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.
{
"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.
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.