Submitters

Get a submitter

The API endpoint provides functionality to retrieve information about a submitter, along with the submitter documents and field values.

get/submitters/{id}

Path parameters

idinteger required

The unique identifier of the submitter.

idinteger required

Submitter unique ID number.

submission_idinteger required

Submission unique ID number.

uuidstring required

Submitter UUID.

emailstring nullable required

The email address of the submitter.

slugstring required

Unique key to be used in the form signing link and embedded form.

sent_atstring nullable required

The date and time when the signing request was sent to the submitter.

opened_atstring nullable required

The date and time when the submitter opened the signing form.

completed_atstring nullable required

The date and time when the submitter completed the signing form.

declined_atstring nullable required

The date and time when the submitter declined the signing form.

created_atstring required

The date and time when the submitter was created.

updated_atstring required

The date and time when the submitter was last updated.

namestring nullable required

The name of the submitter.

phonestring nullable required

The phone number of the submitter.

status'completed' | 'declined' | 'opened' | 'sent' | 'awaiting' required

The status of signing request for the submitter.

external_idstring nullable required

Your application-specific unique string key to identify this submitter within your app.

metadataobject required

Metadata object with additional submitter information.

preferencesobject required

Submitter preferences.

rolestring required

The role of the submitter in the signing process.

No recorded changes to this endpoint across all 1 revision of this API.