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

Request fields

4 fields
query.filer_idRequiredstring (uuid)

ID of the filer that owns this operation's records.

query.recipient_idRequiredstring (uuid)

ID of the recipient within the selected filer.

query.limitOptionalinteger

Maximum number of results requested for this page. Minimum: 1. Maximum: 100.

query.cursorOptionalstring

Opaque next_cursor from the previous page. Keep the other filters unchanged. Minimum characters: 1. Maximum characters: 2048.

Headers (2)
AuthorizationRequired
OAuth RS256 access token issued for the EFM API resource. Interactive EFM session tokens are rejected.
DPoPConditional / optional
Required when the application, connection, or credential is proof-of-possession bound.
cURL request
curl --request GET 'https://api.efilemagic.com/api/v1/recipients/history/list' \
  --header 'Authorization: Bearer <access-token>' \
  --get \
  --data-urlencode 'filer_id=<filer_id>' \
  --data-urlencode 'recipient_id=<recipient_id>' \
  --data-urlencode 'limit=25'

Replace placeholders with your own values. Use the API resource origin provided for your environment.