E-File Magic

Search

Search account records

Find authorized filers, recipients, orders and other supported records using the same tenant search as the application.

POST
/api/v1/search
Authentication
OAuth 2.0 access token
Required scopes
See authentication requirements
Idempotency key
Not required
Rate-limit cost
5 units

How to use this endpoint

Omit domains to search the domains permitted by your token. Explicit domains require their matching read scopes; staff domains and retired print exports are rejected. Optional filer_id narrows results to an authorized filer.

Results are a bounded discovery window. Search can lag a successful save. Filer-filtered results always report partial=true and filtered_window=true; no hidden-record totals or ranking metadata are exposed. Use returned IDs with normal read endpoints.

Use entity_id with the matching record API. For order_deliverables, use the returned order_id and service_code with the deliverable read/download tools; entity_id is a composite search reference.

For recipient names, q may contain complete indexed words followed by a final alphabetic name prefix or initial: chris mal can find Chris Maloney. Earlier terms remain exact. This does not add standalone prefixes, all-partial queries, substring matching or partial email lookup. Existing discovery-window limits and partial semantics apply; no additional matches outside the bounded window are promised.

The first-party Filer and Recipient directories highlight literal query text within existing visible names and locations. This display decoration adds no response field or field-level match attribution and does not change which records the API returns.

cURL request
curl --request POST 'https://api.efilemagic.com/api/v1/search' \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data-binary @request.json

Replace 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.