Events
List events
Retrieves a paginated list of events belonging to the authenticated user.
x-api-key
<token>
API Key for authentication
In: header
Query Parameters
take
number
Range
1 <= value <= 100from
string
Response Body
curl -X GET "https://api.scan-documents.com/v1/events?take=1&from=string"{
"data": [
{
"id": "event_euyrvozb9302uwhq",
"type": "file.created",
"data": {
"id": "file_euyrvozb9302uwhq",
"name": "generated-file",
"type": "image/png",
"properties": {
"width": 1920,
"height": 1080,
"size": 1024
},
"task_id": "task_euyrvozb9302uwhq"
},
"timestamp": "2023-10-01T12:00:00Z"
}
],
"links": {
"previous": "https://api.scan-documents.com/events?from=event_euyrvozb9302uwhq&take=1",
"next": "https://api.scan-documents.com/events?from=event_euyrvozb9302uwhq&take=1"
}
}{
"type": "https://scan-documents.com/docs/errors/validation-error",
"title": "Validation Error",
"status": 422,
"errors": {
"{field}": [
"{error}."
]
}
}{
"type": "https://scan-documents.com/docs/errors/rate-limit-error",
"title": "Rate Limit Exceeded",
"status": 429,
"message": "Rate limit exceeded. Please try again later or contact support."
}{
"type": "https://scan-documents.com/docs/errors/internal-error",
"title": "An unexpected error occurred. Contact support if the problem persists.",
"status": 500,
"message": "An unexpected error occurred. Contact support if the problem persists."
}