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

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
domainsAlways returnedarray<string>

Maximum items: 10.

filtered_windowAlways returnedboolean

Type: boolean.

hitsAlways returnedarray<object>

Maximum items: 100.

Nested fields (9)

domainAlways returnedstring

Allowed values: "filers", "recipients", "orders", "file_submissions", "w9_issuers", "w9_requests", "w9_imports", "delivery_artifacts", "order_deliverables", "import_services".

entity_idAlways returnedstring

Type: string.

excerptAlways returnedstring | null

Type: string | null.

filer_idAlways returnedstring (uuid) | null

Type: string (uuid) | null.

is_archivedAlways returnedboolean

Type: boolean.

order_idAlways returnedstring (uuid) | null

Type: string (uuid) | null.

service_codeAlways returnedstring | null

Allowed values: "efile", "e_delivery", "state_efile", "print_mail", "tin_matching", "irs_spec_file", "excel_processing", "professional_services", "w9_collection".

titleAlways returnedstring | null

Type: string | null.

updated_atAlways returnedstring | null

Type: string | null.

limitAlways returnedinteger

Minimum: 1. Maximum: 100.

partialAlways returnedboolean

Type: boolean.

Complete response schema: ApiSearchResponse

Structure · HTTP 200
{
  "data": {
    "domains": "array<string>",
    "filtered_window": "boolean",
    "hits": "array<object>",
    "limit": "integer",
    "partial": "boolean"
  },
  "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.