Tasks

List Tasks

List the available tasks

GET
https://api.textreveal.com/v3/tasks

Request

Parameters

  • sizeinteger

    Number of records per page

    Default: 10Range: [1, 1000]
  • search_afterstring

    search_after field value from the previous page

  • fields(string (enum))[]

    Fields to include in the response

    Default: ["id", "status", "description", "type", "created_at", "completed_at"]Values: "id", "status", "description", "type", "created_at", "completed_at"
  • orderstring[]

    Order to apply to the result.

    Possible fields are: created_at, completed_at, status.

    Possible directions are: asc and desc.

    You can specifiy multiples values.

    Default: ["created_at:desc", "completed_at:desc", "status:desc"]

Response

Response - 200

Properties of the tasks

  • data*object[]

    Properties of the tasks. Only the tasks available for you are returned.

  • size*integer

    Number of records per page requested.

    Example: 1
  • has_next*boolean

    True if there are more records available.

    Example: true
  • count*integer

    Number of records returned in the current page.

    Example: 1
  • search_after*string | null

    Cursor for next page.

Response
{
  "data": [
    {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "status": "starting",
      "description": "CSV Export - Universe 'MSCI World'",
      "type": "export",
      "created_at": "2026-02-18T12:34:56Z",
      "completed_at": "2025-04-09T14:15:54.000Z"
    }
  ],
  "size": 1,
  "has_next": true,
  "count": 1,
  "search_after": "string"
}

Error

Error - 400

Bad request

  • message*string

    Error message.

    Example: "The server returned an unexpected response"
  • code*integer

    Error code.

    Example: 400
  • reason*string (enum)

    Error reason.

    Values: "invalid", "timeout", "offline", "unknown", "not_found", "unauthorized", "forbidden", "internal", "too_many_requests"
  • errorsobject[]

    Possible error causes, like query params, headers or body.

Response
{
  "message": "The server returned an unexpected response",
  "code": 400,
  "reason": "invalid",
  "errors": [
    {
      "message": "Expected number, received string",
      "field": "size",
      "reason": "invalid_type"
    }
  ]
}

Error - 403

Not authorized

  • message*string
    Example: "Not authorized to access this resource"
  • code*number (enum)

    Error code.

    Values: 403
  • reason*string (enum)
    Values: "forbidden"
Response
{
  "message": "Not authorized to access this resource",
  "code": 403,
  "reason": "forbidden"
}

Error - 404

Not found

  • message*string
    Example: "[record] not found."
  • code*number (enum)

    Error code.

    Values: 404
  • reason*string (enum)
    Values: "not_found"
Response
{
  "message": "[record] not found.",
  "code": 404,
  "reason": "not_found"
}