v51

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-0118684573.2 KB

Roles

Getting Role Details

Getting an individual Role does not reveal any additional information over listing all Roles. It is, however, useful for direct lookup of a specific role:

The id parameter for Roles here and elsewhere will accept the numeric ID associated with that Role, or a system name if there is one associated with the Role. Thus, you may request /v1/roles/admin on any ODK Central server and receive information about the Administrator role.

As with Role listing, there are no authorization restrictions upon this endpoint: anybody is allowed to get information about any Role at any time.

get/v1/roles/{id}

Path parameters

idstring required

Typically the integer ID of the Role. You may also supply the Role system name if it has one.

Response

idnumber

The numerical ID of the Role.

namestring

The human-readable name for the Role.

systemstring

The system name of the Role. Roles that have system names may not be modified.

verbsstring[]

The array of string verbs this Role confers.

createdAtstring

ISO date format

updatedAtstring

ISO date format

Example response

{
  "id": 4,
  "name": "Project Manager",
  "system": "manager",
  "verbs": [
    "project.update",
    "project.delete"
  ],
  "createdAt": "2018-04-18T23:42:11.406Z",
  "updatedAt": "2018-09-18T23:42:11.406Z"
}