Skip to main content
Admins

List admin roles

Returns all available admin roles and their permissions.

GET
/v2/admins/roles

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
  • manage_outbound - Can manage outbound messages
  • manage_outbound_state - Can manage outbound message state
  • auto_approve_posts - Posts auto-approved
Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Example: 2026-08-19.orbit

Response

application/json

Success

dataobject[]required

Array of admin roles

nextCursorstring | nullrequired

Cursor for fetching the next page (cursor-based pagination)

objectenum<string>required

Object type identifier

Available options: list
Example: list