List Sign Events
GET/agreements/:agreement_id/participants/:participant_id/sign_events
Lists all sign events for the participant. The events are returned in ascending order by creation date. Events are read only.
Request
Path Parameters
GET /agreements/:agreement_id/participants/:participant_id/sign_events parameter
GET /agreements/:agreement_id/participants/:participant_id/sign_events parameter
Responses
- 200
- 400
GET /agreements/:agreement_id/participants/:participant_id/sign_events Successful response
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- MOD1
- 118cb3b11b8a1f3b6b1e60a89f96a8be9da32a0f
- MOD3
- MOD1
- MOD3
- Array [
- ]
- ]
Possible values: [1.0
]
The version of the response schema
Possible values: [list
]
A non-paginated list of the sign event resource.
Possible values: [sign_event
]
Data contains the sign event resource.
data object[]required
The unique identifier of the sign event
Possible values: [sign_event
]
The title of the event
The description of the event
The user agent of the browser which triggered the event
The IP address of the request which triggered the event
participant object required
string
Possible values: [1.0
]
The version of the response schema
Possible values: [single
]
A single object of the signing_group resource.
Possible values: [signing_group
]
Data contains the signing_group resource.
data objectrequired
The resource data.
The unique identifier of the signing group
Possible values: [signing_group
]
The name of the signing group
Possible values: [draft
, pending
, fulfilled
]
The status of the signing group
Possible values: >= 5e-324
and <= 1.7976931348623157e+308
The queue number of the signing group
participants object required
string
string
The unique identifier of the agreement this signing group belongs to
UTC datetime ISO string
UTC datetime ISO string
string
UTC datetime ISO string
UTC datetime ISO string
{
"version": "1.0",
"result_type": "list",
"resource_type": "sign_event",
"data": [
{
"id": "cab8rsoepwbc7gzawtnexample",
"resource_type": "sign_event",
"title": "Sign completed",
"description": "Completed signing of the documment with swedish mobile BankID.",
"user_agent": "Mozilla/5.0 (Linux; Android 10; SM-G960F) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.210 Mobile Safari/537.36",
"ip_address": "192.168.0.1",
"participant": "cmfwtsm5nw90yyq4dhkexample",
"created_at": "2024-01-01T00:00:00.000Z",
"updated_at": "2024-01-01T00:00:00.000Z"
}
]
}
GET /agreements/:agreement_id/participants/:participant_id/sign_events Error response
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [error
]
error objectrequired
Possible values: >= 400
and <= 599
{
"status": "error",
"error": {
"code": 0,
"message": "string",
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
}