User / team / organization / usage

Changed on

Retrieve Organization Assets

This endpoint returns all assets associated with a specific organization. The assets listed here are restricted to those owned by the specified organization.

Only the owner or administrators of the organization can access this endpoint.

Additional Information

For more details, please refer to /api/v2/assets/.

get/api/v2/organizations/{uid_organization}/assets/

Request

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

Path parameters

uid_organizationstring required

A unique value identifying this organization.

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