Sign in

v1

latestOpenAPI 3.1.02026-07-14220425.8 KB
Submitters

List all submitters

The API endpoint provides the ability to retrieve a list of submitters.

get/submitters

Query parameters

submission_idinteger

The submission ID allows you to receive only the submitters related to that specific submission.

qstring

Filter submitters on name, email or phone partial match.

slugstring

Filter submitters by unique slug.

completed_afterstring date-time

The date and time string value to filter submitters that completed the submission after the specified date and time.

completed_beforestring date-time

The date and time string value to filter submitters that completed the submission before the specified date and time.

external_idstring

The unique application-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external ID.

limitinteger

The number of submitters to return. Default value is 10. Maximum value is 100.

afterinteger

The unique identifier of the submitter to start the list from. It allows you to receive only submitters with an ID greater than the specified value. Pass ID value from the pagination.next response to load the next batch of submitters.

beforeinteger

The unique identifier of the submitter to end the list with. It allows you to receive only submitters with an ID less than the specified value.

Response

OK