Sign in
User / team / organization / usage

Retrieve organization's details

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

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

idstring required
urlstring uri required
namestring required
websitestring required
organization_type'non-profit' | 'government' | 'educational' | 'commercial' | 'none' required
  • non-profit - Non-profit organization
  • government - Government institution
  • educational - Educational organization
  • commercial - A commercial/for-profit company
  • none - I am not associated with any organization
createdstring date-time required
modifiedstring date-time required
is_ownerboolean required
is_mmoboolean required
request_user_role'admin' | 'member' | 'owner' required
  • admin - admin
  • member - member
  • owner - owner
membersstring uri required
assetsstring uri required
service_usagestring uri required
asset_usagestring uri required

Example response

{
  "url": "https://kf.kobotoolbox.org/api/v2/organizations/orgzeph7Ub8tVmJ82JBbH96n/",
  "members": "https://kf.kobotoolbox.org/api/v2/organizations/orgzeph7Ub8tVmJ82JBbH96n/members/",
  "assets": "https://kf.kobotoolbox.org/api/v2/organizations/orgzeph7Ub8tVmJ82JBbH96n/assets/",
  "service_usage": "https://kf.kobotoolbox.org/api/v2/organizations/orgzeph7Ub8tVmJ82JBbH96n/service_usage/",
  "asset_usage": "https://kf.kobotoolbox.org/api/v2/organizations/orgzeph7Ub8tVmJ82JBbH96n/assets_usage/"
}

Changes

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