GET
List available permissions (organization)
Organization space User accounts only For: Administrator · Permission: permissions.list Conditions
  • The list has one entry per permission group of the organization space.
Part of Define access profiles and roles.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, name, title, description, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

200 - application/json

Resource.

id

Identifier of the permission: its group id (27-character KSUID).

name

Technical name of the permission, such as orders.approve, used in checks.

title

Translated short title of the permission, from the language files.

description

Translated explanation of what the permission allows.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).