Manage projects and library content

Changed on

Get user's assets

Search can be made with q parameter. Search filters can be returned with results by passing metadata=on to querystring.

Results can be sorted with ordering parameter, e.g.:

curl -X GET https://kf.kobotoolbox.org/api/v2/assets/?ordering=-name

Allowed fields are:

  • asset_type
  • date_modified
  • date_deployed
  • date_modified__date
  • date_deployed__date
  • name
  • settings__sector
  • settings__sector__value
  • settings__description
  • owner__username
  • owner__extra_details__data__name
  • owner__extra_details__data__organization
  • owner__email
  • _deployment_status
  • subscribers_count

Note: Collections can be displayed first with parameter collections_first, e.g.:

curl -X GET https://kf.kobotoolbox.org/api/v2/assets/?collections_first=true&ordering=-name
get/api/v2/assets/

Request

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

Query parameters

current_user_permissions_onlyboolean

When true, only return the requesting user's own permission assignments. When false (default), return all visible assignments.

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.

qstring

Filter the results with search query

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/aBeA23YCYjkGTFvYVHuAyU/",
      "owner": "https://kf.kobotoolbox.org/api/v2/users/bob/",
      "parent": "https://kf.kobotoolbox.org/api/v2/assets/a3C9wWefqZVkChNLKqqXVZ/",
      "deployed_versions": {
        "results": [
          {
            "url": "https://kf.kobotoolbox.org/api/v2/assets/aBeA23YCYjkGTFvYVHuAyU/versions/vBeA23YCYjkGTFvYVHuAyU/"
          }
        ]
      },
      "xform_link": "https://kf.kobotoolbox.org/api/v2/assets/aBeA23YCYjkGTFvYVHuAyU/xform/",
      "hooks_link": "https://kf.kobotoolbox.org/api/v2/assets/aBeA23YCYjkGTFvYVHuAyU/hooks/",
      "xls_link": "https://kf.kobotoolbox.org/api/v2/assets/aBeA23YCYjkGTFvYVHuAyU.xls",
      "exports": "https://kf.kobotoolbox.org/api/v2/assets/aBeA23YCYjkGTFvYVHuAyU/exports/",
      "data": "https://kf.kobotoolbox.org/api/v2/assets/aBeA23YCYjkGTFvYVHuAyU/data/",
      "paired_data": "https://kf.kobotoolbox.org/api/v2/assets/aBeA23YCYjkGTFvYVHuAyU/paired-data/"
    }
  ]
}

Changes

  • v27f81278fee5aRevision changes
    • breaking

      the response property //// became nullable for the status

  • v241cb6ede9360Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status