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

List project roles

Lists the roles configured for a project. Use after to continue from the previous page's cursor, and use limit and order to control the page size and sort direction.

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

4 parameters
project_idstringrequired
The ID of the project to inspect.
limitintegeroptional
The maximum number of roles to return. Defaults to 1000 when omitted.
Default:1000
afterstringoptional
The pagination cursor from the previous response's `next` field.
orderstringoptional
The sort order for returned roles: `asc` or `desc`. Defaults to `asc` when omitted.
Allowed:ascdescDefault:asc

2 status codes
200Returns a paginated list of project roles with the current page's roles, a `has_more` indicator, and a `next` cursor when more 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.
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. limit must be between 0 and 1000, and order must be asc or desc when provided.