OpenAI API (unofficial showcase)
GET/organization/roles/{role_id}

Retrieve an organization role

Retrieves a role configured for the organization. Use role_id to identify the role and review its name, permissions, and resource type.

1 parameter
role_idstringrequired
The unique identifier of the role to retrieve.

4 status codes
200Returns the role object with its identifier, name, description, permissions, resource type, and whether it is predefined.
objectstringrequired
Always `role`.
Allowed:role
idstringrequired
Identifier for the role.
namestringrequired
Unique name for the role.
descriptionstringrequired
Optional description of the role.
permissionsarray<string>required
Permissions granted by the role.
resource_typestringrequired
Resource type the role is bound to (for example `api.organization` or `api.project`).
predefined_rolebooleanrequired
Whether the role is predefined and managed by OpenAI.
403Returned when the caller does not have permission to perform this operation.
errorobjectrequired
Details about the permission error.
404Returned when the endpoint is unavailable or a requested resource is not found in the organization or project.
errorobjectrequired
429Returned when the request is rejected because a rate limit was exceeded.
errorobjectrequired

Error handling

A 403 is returned when the authenticated user does not have permission to perform this operation. A 404 is returned when the endpoint is unavailable or the requested role is not found in the organization or project. A 429 is returned when a rate limit is exceeded.