Role

Role identity and display metadata

  • object
    Type: string

    Resource type identifier

  • id
    Type: string

    Unique identifier for the role

  • name
    Type: string

    Role display name

  • slug
    Type: string

    URL-safe role slug

  • description
    Type: string

    Description of the role's purpose

  • is_system
    Type: boolean

    Whether this is a system role (member, billing, admin, owner)

  • enabled
    Type: boolean

    Whether the role can be assigned. A custom role is disabled when a plan change leaves the organization over its custom role allowance; its definition and permissions survive, and re-enabling it restores them. System roles are always enabled.

  • created_at
    Type: string

    When the role was created

  • updated_at
    Type: string

    When the role was last updated