list_company_roles
Retrieve company role definitions, including system roles with negative IDs, to see available roles and support permission mapping.
Instructions
Read company role definitions, including system roles with negative IDs.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| detail | No | ||
| offset | No | ||
| text_offsets | No | JSON pointer -> character offset. Reuse the same page and all returned text cursors to continue. | |
| previous_page | No | Pass page_fingerprint from the preceding page to detect an API ignoring pagination. | |
| section_offsets | No | JSON pointer -> nested array offset. Reuse the same page to continue a section. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| item | No | ||
| error | No | ||
| items | No | ||
| limit | No | ||
| total | No | ||
| offset | No | ||
| metadata | No | ||
| warnings | No | ||
| pagination | No | ||
| next_offset | No | ||
| continuation | No | ||
| comments_limit | No | ||
| comments_offset | No | ||
| page_fingerprint | No | ||
| comments_included | No | ||
| next_text_offsets | No | ||
| comments_next_offset | No | ||
| total_in_selected_pages | No | ||
| comments_page_fingerprint | No |