Tasks

List tasks

Retrieves a paginated list of tasks belonging to the authenticated user.

GET
/v1/tasks
x-api-key
<token>

API Key for authentication

In: header

Query Parameters

take
number
Default20
Range1 <= value <= 100
from
string

Response Body

curl -X GET "https://api.scan-documents.com/v1/tasks?take=20&from=string"
{
  "data": [
    {
      "id": "task_euyrvozb9302uwhq",
      "operation": "apply-effect",
      "parameters": {
        "input": "file_avyrvozb9302uwhq",
        "name": "Example Image",
        "effect": "grayscale",
        "callback_url": "https://example.com/callback"
      },
      "status": "completed",
      "result": {
        "generated_files": [
          {
            "id": "file_euyrvozb9302uwhq",
            "name": "Example Image",
            "type": "image/png",
            "properties": {
              "size": 1024,
              "width": 800,
              "height": 600
            },
            "task_id": "task_euyrvozb9302uwhq",
            "created_at": "2021-05-01T12:00:00Z"
          }
        ]
      },
      "callback_url": "https://example.com/callback",
      "created_at": "2021-05-01T12:00:00Z",
      "updated_at": "2021-05-01T12:00:00Z"
    }
  ],
  "links": {
    "previous": "string",
    "next": "string"
  }
}
{
  "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."
}