Skip to main content
GET
Error

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

​
emailAddress
string<email>
required

The email address of the person

Example:

"hello@world.test"

​
status
enum<string>

The status of actors to retrieve

Available options:
Available,
Finished,
Rejected,
Failed
​
type
enum<string>

The type of actors to retrieve

Available options:
Signer,
Receiver,
Approver,
FormFiller
​
pageNumber
integer
default:0

The page to retrieve

Required range: x >= 0
​
pageSize
integer
default:20

Maximum number of records in the response

Required range: x >= 1
​
createdBefore
string<date>

Select items created before given date

Example:

"2020-01-15"

​
createdAfter
string<date>

Select items created after given date

Example:

"2020-01-14"

​
sort
enum<string>
default:desc

specify how the result is sorted, default is descending

Available options:
asc,
desc

Response

List of actors across packages for given person.

​
PageSize
integer

The requested page size

Example:

20

​
Total
integer

The total number of items

Example:

1

​
Items
object[]