Sample - OpenAI API
GET/projects/{project_id}/roles/{role_id}

Retrieve a project role

Retrieves a project role. Supply project_id and role_id to identify the project and the role you want to inspect.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
project_idstringrequired
The ID of the project.
role_idstringrequired
The ID of the role to retrieve.

2 status codes
200Returns the project role with its identifier, unique name, description, permissions, resource type, and predefined-role status.
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.
429Returned when the request was rejected because a rate limit was exceeded.
errorobjectrequired

Error handling

A 429 is returned when the request exceeds the applicable rate limit. project_id and role_id must identify the project and role you want to retrieve.