Organisations

Organisations group the accounts available to a customer or business entity.

Organisations are currently created by Umnai during onboarding. Use the API to retrieve the organisations your credentials can access and to inspect a specific organisation when you already have its id.

Retrieve organisations

Retrieve the organisations available to the current credentials.

curl https://api.hi.umnai.com/organisations \
     -H "Authorization: Bearer <token>"

{
  "data": [
    {
      "id": "ea8b745ead39ec442fc3b4fba359bf98",
      "name": "Sample Organisation",
      "status": "ACTIVE",
      "created_at": "2026-03-11T16:04:19.749000Z"
    }
  ],
  "pagination": {
    "total_items": 1,
    "items_per_page": 10,
    "current_page": 1,
    "total_pages": 1
  }
}

Use the returned organisation id when you need to inspect a specific organisation or relate accounts back to their parent organisation.

Retrieve an organisation

Retrieve a specific organisation by its id.

curl https://api.hi.umnai.com/organisations/organisationId \
     -H "Authorization: Bearer <token>"

{
  "id": "3dda443ae06935b84a7c2859c519e664",
  "name": "Sample Organisation",
  "status": "ACTIVE",
  "created_at": "2026-03-11T16:04:19.749000Z"
}