E-File Magic

Recipients

Read recipient history

Review a recipient's saved versions and form changes.

GET
/api/v1/recipients/history/list
Authentication
OAuth 2.0 access token
Required scopes
recipients.readforms.read
Idempotency key
Not required
Rate-limit cost
2 units

On success, data contains the fields below. meta includes api_version and request_id. Keep request_id when reporting a problem.

Response fields

3 fields
itemsAlways returnedarray<object>

Maximum items: 100.

Nested fields (15)

actor_idMay be omittedstring | null

Type: string | null.

actor_typeAlways returnedstring

Type: string.

event_atAlways returnedstring (date-time)

Type: string (date-time).

event_familyAlways returnedstring

Type: string.

event_typeAlways returnedstring

Type: string.

filer_idAlways returnedstring (uuid)

Type: string (uuid).

history_idAlways returnedstring

Type: string.

line_idMay be omittedstring (uuid) | null

Type: string (uuid) | null.

order_idMay be omittedstring (uuid) | null

Type: string (uuid) | null.

payloadAlways returnedobject

Type: object.

providerMay be omittedstring | null

Type: string | null.

recipient_idAlways returnedstring (uuid)

Type: string (uuid).

recipient_record_stateAlways returnedstring

Allowed values: "active", "archived", "deleted", "orphaned".

service_codeMay be omittedstring | null

Type: string | null.

statusAlways returnedstring

Type: string.

next_cursorMay be omittedstring | null

Maximum characters: 4096.

total_countMay be omittedinteger | null

Minimum: 0.

Complete response schema: ApiV1RecipientHistoryListResponse

Example · HTTP 200
{
  "data": {
    "items": [],
    "next_cursor": null,
    "total_count": null
  },
  "meta": {
    "api_version": "v1",
    "request_id": "example-request-id"
  }
}

No matching records. Synthetic empty-page example. Follow a non-null next_cursor even when items is empty. A null total_count means no count was supplied.