Roles

Roles determine the access assigned to users within an account. Review which roles are available and retrieve the role IDs required when inviting users.

Role and permission management is not fully exposed in the customer-facing API. You can retrieve available roles, but you cannot create, update, or manage roles through this API.

Retrieve roles

Retrieve the roles available for assignment.

1
curl https://api.hi.umnai.com/roles

1
{
2
  "data": [
3
    {
4
      "id": "ea8b745ead39ec442fc3b4fba359bf98",
5
      "name": "Sample Organisation",
6
      "status": "ACTIVE",
7
      "created_at": "2026-03-11T16:04:19.749000Z",
8
      "updated_at": null
9
    }
10
  ],
11
  "pagination": {
12
    "total_items": 1,
13
    "items_per_page": 10,
14
    "current_page": 1,
15
    "total_pages": 1
16
  }
17
}

Use the returned role id in role_ids when inviting a user.