# List admin roles

Returns all available admin roles and their permissions.

This endpoint returns all roles at once (typically a small list). No pagination is supported.

### Response Format

Returns a list object with:
- object - Always "list"
- data - Array of admin role objects
- nextCursor - Always null

### Admin Role Object

Each role includes:
- id - Unique role identifier
- name - Role name (e.g., "Admin", "Viewer")
- permissions - Object containing permission flags

### Permissions

The permissions object contains boolean flags for each permission:
- view_comments_private - Can view private comments
- manage_comments - Can manage comments
- manage_comments_private - Can manage private comments
- set_comment_pinned - Can pin comments
- moderate_comments - Can moderate comments
- set_post_category - Can change post categories
- set_post_pinned - Can pin posts
- set_post_eta - Can set post ETA
- set_post_tags - Can manage post tags
- set_post_author - Can change post author
- set_post_status - Can change post status
- set_post_assignee - Can assign posts
- set_post_custom_fields - Can edit custom fields
- post_vote_on_behalf - Can vote on behalf of users
- post_merge - Can merge posts
- post_import - Can import posts
- post_export - Can export posts
- moderate_posts - Can moderate posts
- view_users - Can view users
- manage_users - Can manage users
- view_posts_private - Can view private posts
- view_private_post_tags - Can view private tags
- manage_changelogs - Can manage changelogs
- manage_surveys - Can manage surveys
- manage_branding - Can manage branding
- manage_billing - Can manage billing
- manage_team_members - Can manage team members
- manage_sso - Can manage SSO settings
- manage_api - Can manage API settings
- manage_statuses - Can manage statuses
- manage_boards - Can manage boards
- manage_post_tags - Can manage post tags
- manage_custom_fields - Can manage custom fields
- manage_moderation_settings - Can manage moderation
- manage_roadmap - Can manage roadmap
- manage_user_roles - Can manage user roles
- manage_prioritization - Can manage prioritization
- manage_notifications - Can manage notifications
- manage_custom_domain - Can manage custom domain
- manage_integrations - Can manage integrations
- use_integrations - Can use integrations
- manage_help_center - Can manage help center
- auto_approve_posts - Posts auto-approved

Endpoint: GET /v2/admins/roles
Version: 2026-01-01.nova
Security: bearerAuth

## Header parameters:

  - `Featurebase-Version` (string)
    API version for this request. Defaults to your organization's configured API version if not specified.
    Example: "2026-01-01.nova"

## Response 200 fields (application/json):

  - `object` (string, required)
    Object type identifier
    Enum: "list"

  - `data` (array, required)
    Array of admin roles
    Example: []

  - `data.id` (string, required)
    Role unique identifier
    Example: "6648f22b7b23fb2f4307aafe"

  - `data.name` (string, required)
    Role name
    Example: "Admin"

  - `data.permissions` (object, required)
    Role permissions

  - `data.permissions.view_comments_private` (boolean)
    View private comments

  - `data.permissions.manage_comments` (boolean)
    Manage comments
    Example: true

  - `data.permissions.manage_comments_private` (boolean)
    Manage private comments

  - `data.permissions.set_comment_pinned` (boolean)
    Pin/unpin comments
    Example: true

  - `data.permissions.moderate_comments` (boolean)
    Moderate comments
    Example: true

  - `data.permissions.set_post_category` (boolean)
    Set post category/board
    Example: true

  - `data.permissions.set_post_pinned` (boolean)
    Pin/unpin posts
    Example: true

  - `data.permissions.set_post_eta` (boolean)
    Set post ETA
    Example: true

  - `data.permissions.set_post_tags` (boolean)
    Set post tags
    Example: true

  - `data.permissions.set_post_author` (boolean)
    Set post author
    Example: true

  - `data.permissions.set_post_status` (boolean)
    Set post status
    Example: true

  - `data.permissions.set_post_assignee` (boolean)
    Assign posts
    Example: true

  - `data.permissions.set_post_custom_fields` (boolean)
    Set post custom fields
    Example: true

  - `data.permissions.post_vote_on_behalf` (boolean)
    Vote on posts on behalf of users

  - `data.permissions.post_merge` (boolean)
    Merge posts
    Example: true

  - `data.permissions.post_import` (boolean)
    Import posts

  - `data.permissions.post_export` (boolean)
    Export posts
    Example: true

  - `data.permissions.moderate_posts` (boolean)
    Moderate posts
    Example: true

  - `data.permissions.view_users` (boolean)
    View users
    Example: true

  - `data.permissions.manage_users` (boolean)
    Manage users
    Example: true

  - `data.permissions.view_posts_private` (boolean)
    View private posts

  - `data.permissions.view_private_post_tags` (boolean)
    View private post tags

  - `data.permissions.manage_changelogs` (boolean)
    Manage changelogs
    Example: true

  - `data.permissions.manage_surveys` (boolean)
    Manage surveys
    Example: true

  - `data.permissions.manage_branding` (boolean)
    Manage branding

  - `data.permissions.manage_billing` (boolean)
    Manage billing

  - `data.permissions.manage_team_members` (boolean)
    Manage team members
    Example: true

  - `data.permissions.manage_sso` (boolean)
    Manage SSO

  - `data.permissions.manage_api` (boolean)
    Manage API settings

  - `data.permissions.manage_statuses` (boolean)
    Manage post statuses
    Example: true

  - `data.permissions.manage_boards` (boolean)
    Manage boards
    Example: true

  - `data.permissions.manage_post_tags` (boolean)
    Manage post tags
    Example: true

  - `data.permissions.manage_custom_fields` (boolean)
    Manage custom fields
    Example: true

  - `data.permissions.manage_moderation_settings` (boolean)
    Manage moderation settings
    Example: true

  - `data.permissions.manage_roadmap` (boolean)
    Manage roadmap
    Example: true

  - `data.permissions.manage_user_roles` (boolean)
    Manage user roles
    Example: true

  - `data.permissions.manage_prioritization` (boolean)
    Manage prioritization
    Example: true

  - `data.permissions.manage_notifications` (boolean)
    Manage notifications
    Example: true

  - `data.permissions.manage_custom_domain` (boolean)
    Manage custom domain

  - `data.permissions.manage_integrations` (boolean)
    Manage integrations

  - `data.permissions.use_integrations` (boolean)
    Use integrations
    Example: true

  - `data.permissions.manage_help_center` (boolean)
    Manage help center
    Example: true

  - `data.permissions.auto_approve_posts` (boolean)
    Auto-approve posts

  - `nextCursor` (string,null, required)
    Cursor for fetching the next page (cursor-based pagination)

## Response 400 fields (application/json):

  - `error` (object, required)

  - `error.type` (string, required)
    The type of error returned
    Enum: "invalid_request_error"

  - `error.code` (string, required)
    Machine-readable error code
    Enum: "invalid_id", "invalid_parameter", "missing_parameter", "invalid_cursor", "invalid_content", "invalid_request", "contact_not_customer", "contact_not_attached", "parameter_not_supported"

  - `error.message` (string, required)
    Example: "Invalid post ID format"

  - `error.param` (string)
    Example: "id"

  - `error.status` (number, required)
    HTTP status code
    Enum: 400

  - `error.details` (array)
    Additional validation error details

  - `error.details.path` (string, required)
    Example: "body.name"

## Response 404 fields (application/json):

  - `error` (object, required)

  - `error.type` (string, required)
    The type of error returned
    Enum: "invalid_request_error"

  - `error.code` (string, required)
    Machine-readable error code
    Enum: "resource_not_found", "post_not_found", "comment_not_found", "changelog_not_found", "admin_not_found", "contact_not_found", "conversation_not_found", "conversation_part_not_found", "team_not_found", "survey_not_found", "company_not_found", "help_center_not_found", "collection_not_found", "article_not_found", "custom_field_not_found", "board_not_found", "voter_not_found", "participant_not_found", "webhook_not_found", "version_not_supported"

  - `error.message` (string, required)
    Example: "Post not found"

  - `error.status` (number, required)
    HTTP status code
    Enum: 404

## Response 500 fields (application/json):

  - `error` (object, required)

  - `error.type` (string, required)
    The type of error returned
    Enum: "api_error"

  - `error.code` (string, required)
    Machine-readable error code
    Enum: "database_error", "internal_error", "fetch_error", "create_error", "update_error", "delete_error"

  - `error.message` (string, required)
    Example: "An internal error occurred"

  - `error.status` (number, required)
    HTTP status code
    Enum: 500