Skip to main content
GET
Get submitter

Authorizations

X-Auth-Token
string
header
required

API token generated at Settings > API

Path Parameters

id
integer
required

Response

200 - application/json

Full submitter details

id
integer
uuid
string<uuid>
slug
string
signing_url
string<uri>

Absolute signing link, minted on the submission's chosen host (preferences.custom_domain, then the template's, then the account's primary custom domain, then spitshake.io).

Example:

"https://sign.yourcompany.com/s/OGZGoWBpoM8nN8"

email
string<email> | null
name
string | null
role
string
status
enum<string>
Available options:
waiting,
sent,
opened,
completed,
declined,
expired
submission_id
integer
opened_at
string<date-time> | null
sent_at
string<date-time> | null
completed_at
string<date-time> | null
phone
string | null
external_id
string | null
values
object
metadata
object
preferences
object | null
declined_at
string<date-time> | null
documents
object[]
submission_events
object[]
template
object
submission
object