Survey data

List of export tasks endpoints

Lists the export tasks accessible to requesting user, for anonymous access nothing is returned.

<sup>*</sup> Required permissions: view_submissions (View submissions)

Otherwise, the search can be more specific:

Exports matching uids:

curl -X GET https://kf.kobotoolbox.org/api/v2/assets/{asset_uid}/exports/?q=uid__in:ehZUwRctkhp9QfJgvEWGg OR uid__in:ehZUwRctkhp9QfJgvDnjud
get/api/v2/assets/{uid_asset}/exports/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

uid_assetstring required

UID of the parent asset

Query parameters

limitinteger

Number of results to return per page. Use with start.

offsetinteger

Deprecated alias of start.

orderingstring

Which field to use when ordering the results.

startinteger

The initial index from which to return the results. Use with limit.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "https://kf.kobotoolbox.org/api-endpoint/?start=400&limit=100",
  "previous": "https://kf.kobotoolbox.org/api-endpoint/?start=200&limit=100",
  "results": [
    {
      "url": "https://kf.kobotoolbox.org/api/v2/assets/a3C9wWefqZVkChNLKqqXVZ/exports/eYeXfo2KjbSzXgWuKsJNPY/",
      "result": "https://kf.kobotoolbox.org/user/export/NEW PROJECT - all versions - False - 2025-01-01-01-01.csv",
      "data": {
        "source": "https://kf.kobotoolbox.org/api/v2/assets/a3C9wWefqZVkChNLKqqXVZ/"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 50 revisions of this API.