Error
A valid request URL is required to generate request examples[
{
"PageSize": 20,
"Total": 1,
"Items": [
{
"ActorId": "00000000-0000-0000-0000-000000000000",
"Status": "Draft",
"Type": "Signer",
"StakeholderId": "00000000-0000-0000-0000-000000000000",
"PackageId": "00000000-0000-0000-0000-000000000000",
"PackageName": "example package",
"CreationDate": "2023-11-07T05:31:56Z",
"Initiator": "hello@world.test",
"Documents": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "example document"
}
]
}
]
}
][
{
"ErrorCode": "Name.MinimumLength:6",
"ErrorMessage": "The minimum length for a name is 6"
}
]Packages
Get actors for a user
Retrieves all actors across packages for a specific user, identified by email address. Use the query parameters to page and to filter by status, actor type, creation date and sort order.
GET
/
packages
/
actors
Error
A valid request URL is required to generate request examples[
{
"PageSize": 20,
"Total": 1,
"Items": [
{
"ActorId": "00000000-0000-0000-0000-000000000000",
"Status": "Draft",
"Type": "Signer",
"StakeholderId": "00000000-0000-0000-0000-000000000000",
"PackageId": "00000000-0000-0000-0000-000000000000",
"PackageName": "example package",
"CreationDate": "2023-11-07T05:31:56Z",
"Initiator": "hello@world.test",
"Documents": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "example document"
}
]
}
]
}
][
{
"ErrorCode": "Name.MinimumLength:6",
"ErrorMessage": "The minimum length for a name is 6"
}
]Authorizations
basicAuthbearerAuth
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Query Parameters
The email address of the person
Example:
"hello@world.test"
The status of actors to retrieve
Available options:
Available, Finished, Rejected, Failed The type of actors to retrieve
Available options:
Signer, Receiver, Approver, FormFiller The page to retrieve
Required range:
x >= 0Maximum number of records in the response
Required range:
x >= 1Select items created before given date
Example:
"2020-01-15"
Select items created after given date
Example:
"2020-01-14"
specify how the result is sorted, default is descending
Available options:
asc, desc