OpenAI API (unofficial showcase)
GET/projects/{project_id}/roles

List project roles

Lists the roles configured for a project in a paginated response. Use limit to set the page size, after to continue from a cursor, and order to choose the sort direction.

4 parameters
project_idstringrequired
The ID of the project to inspect.
limitintegeroptional
Maximum number of roles to return, from 0 to 1000. Defaults to 1000 when omitted.
Default:1000
afterstringoptional
Pagination cursor from the previous response's `next` field; omit it to start from the first page.
orderstringoptional
Sort order for the returned roles: `asc` or `desc`. Defaults to `asc` when omitted.
Allowed:ascdescDefault:asc

5 status codes
200Returns a paginated list of project roles with `data`, a `has_more` indicator, and a `next` cursor that is null when no further roles are available.
objectstringrequired
Always `list`.
Allowed:list
dataarray<object>required
Roles returned in the current page.
has_morebooleanrequired
Whether more roles are available when paginating.
nextstringrequired
Cursor to fetch the next page of results, or `null` when there are no additional roles.
400Returned when the request parameters are invalid or the requested operation cannot be performed.
errorobjectrequired
403Returned when you do 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 400 is returned when the request parameters are invalid or the operation cannot be performed, and a 403 is returned when you lack permission. A 404 is returned when the endpoint is unavailable or a requested resource is not found; a 429 is returned when the rate limit is exceeded. The project_id path parameter must identify the project, limit must be between 0 and 1000, and order must be asc or desc.