Get signature activities by business
GET/activities/signatures
Returns detailed signature activities for your business and its members within a specified date range.
Use these parameters to filter for a specific time range.
| Parameter | Description | Mandatory |
|---|---|---|
start_date | The start date of the range to fetch the signature activities. Format: yyyy-MM-dd. | yes |
end_date | The end date of the range to fetch the signature activities. Format: yyyy-MM-dd. | yes |
Pagination
The result set can be controlled using the optional pagination parameters page and size
| Parameter | Description | Mandatory |
|---|---|---|
page | The page number to fetch the signature activities. Must be a positive integer. Default: 1 | no |
size | The size of the page to fetch the signature activities. Must be a positive integer. Default: 25 Maximum: 100 | no |
sort | The sort order of the signature activities. Can be asc or desc. Default is desc. | no |
Response
The response contains the following information.
General
| Field | Description |
|---|---|
activities | Array of activities. See the following subchapter Activities. |
total_items | Total items to fetch when paginating through all the pages. |
total_pages | Total pages to fetch when paginating through all the pages. |
current_page | Current page number. |
size | Size of the page. |
Activities
| Field | Description |
|---|---|
id | The ID of the signature activity. |
action | The action type of a signature activity. Can be signed or sealed. |
timestamp | The timestamp of the signature activity. |
signature_request_id | The signature request ID. |
cost_center | The cost center of the signature paying party. This information might not necessarily be present. |
initiator | The initiator user of the signature activity. See the following subchapter User. |
signer | The signer user of the signature activity. See the following subchapter User. |
User
| Field | Description |
|---|---|
email | The email of the user. |
first_name | The first name of the user. |
last_name | The last name of the user. |
type | The membership status of the user in relation to the business. Can be api, external, member or unknown. |
mobile | The mobile number of the user. |
Request
Responses
- 200
- 400
- 401
- 404
- 429
- 500
- 503
OK
Bad request
Unauthorized
Not found
Too many requests
Internal server error
Service unavailable