List Sign Events
GEThttps://api.zigned.se/rest/v3/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
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
{
"version": "1.0",
"result_type": "list",
"resource_type": "sign_event",
"data": [
{
"id": "cry7lxonsuqqmrvi6s5example",
"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": "cihhe1hpnrouo9k70ksexample",
"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
{
"status": "error",
"error": {
"code": 0,
"message": "string",
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
}
Authorization: http
name: HTTP_1type: httpscheme: bearer
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X GET 'https://api.zigned.se/rest/v3/agreements/:agreement_id/participants/:participant_id/sign_events' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'