Skip to main content
GET
/
api
/
v1
/
form_deliveries
Error
A valid request URL is required to generate request examples
[
  {
    "id": "<string>",
    "active": true,
    "address": "<string>",
    "can_be_revoked": true,
    "confirmation_notes": "<string>",
    "confirmation_required": true,
    "confirmation_retry_count": 123,
    "confirmed_at": "<string>",
    "created_at": "<string>",
    "cross_channel_confirmation": true,
    "days_until_expiration": 123,
    "delivered_at": "<string>",
    "expired": true,
    "expires_at": "<string>",
    "expiring_soon": true,
    "form_type": "<string>",
    "meets_requirement": true,
    "recipient_name": "<string>",
    "recipient_type": "<string>",
    "revocation_reason": "<string>",
    "revoked_at": "<string>",
    "sent_at": "<string>",
    "suggested_follow_up_date": "<string>",
    "updated_at": "<string>"
  }
]

Response

200 - application/json

OK

​
id
string
required
​
active
boolean
required
​
address
string
required
​
can_be_revoked
boolean
required
​
channel
enum<string>
required
Available options:
fax,
email,
mail,
portal
​
confirmation_channel
enum<string> | null
required
Available options:
phone_call,
email_response,
portal_check,
in_person,
other
​
confirmation_notes
string | null
required
​
confirmation_required
boolean
required
​
confirmation_retry_count
integer
required
​
confirmed_at
string | null
required
​
created_at
string
required
​
cross_channel_confirmation
boolean
required
​
days_until_expiration
integer | null
required
​
delivered_at
string | null
required
​
expired
boolean
required
​
expires_at
string | null
required
​
expiring_soon
boolean
required
​
form_type
string
required
​
meets_requirement
boolean
required
​
recipient_name
string
required
​
recipient_type
string
required
​
revocation_discovered_via
enum<string> | null
required
Available options:
phone_call,
email_response,
portal_check,
in_person,
other
​
revocation_reason
string | null
required
​
revoked_at
string | null
required
​
sent_at
string | null
required
​
status
enum<string>
required
Available options:
pending,
sent,
delivered,
confirmed,
failed,
expired,
revoked
​
suggested_follow_up_date
string | null
required
​
updated_at
string
required